docusign_esign.models.template_role

  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 TemplateRole(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        'additional_notifications': 'list[RecipientAdditionalNotification]',
 38        'client_user_id': 'str',
 39        'default_recipient': 'str',
 40        'delivery_method': 'str',
 41        'email': 'str',
 42        'email_notification': 'RecipientEmailNotification',
 43        'embedded_recipient_start_url': 'str',
 44        'in_person_signer_name': 'str',
 45        'name': 'str',
 46        'phone_number': 'RecipientPhoneNumber',
 47        'recipient_signature_providers': 'list[RecipientSignatureProvider]',
 48        'role_name': 'str',
 49        'routing_order': 'str',
 50        'signing_group_id': 'str',
 51        'tabs': 'Tabs'
 52    }
 53
 54    attribute_map = {
 55        'access_code': 'accessCode',
 56        'additional_notifications': 'additionalNotifications',
 57        'client_user_id': 'clientUserId',
 58        'default_recipient': 'defaultRecipient',
 59        'delivery_method': 'deliveryMethod',
 60        'email': 'email',
 61        'email_notification': 'emailNotification',
 62        'embedded_recipient_start_url': 'embeddedRecipientStartURL',
 63        'in_person_signer_name': 'inPersonSignerName',
 64        'name': 'name',
 65        'phone_number': 'phoneNumber',
 66        'recipient_signature_providers': 'recipientSignatureProviders',
 67        'role_name': 'roleName',
 68        'routing_order': 'routingOrder',
 69        'signing_group_id': 'signingGroupId',
 70        'tabs': 'tabs'
 71    }
 72
 73    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 74        """TemplateRole - a model defined in Swagger"""  # noqa: E501
 75        if _configuration is None:
 76            _configuration = Configuration()
 77        self._configuration = _configuration
 78
 79        self._access_code = None
 80        self._additional_notifications = None
 81        self._client_user_id = None
 82        self._default_recipient = None
 83        self._delivery_method = None
 84        self._email = None
 85        self._email_notification = None
 86        self._embedded_recipient_start_url = None
 87        self._in_person_signer_name = None
 88        self._name = None
 89        self._phone_number = None
 90        self._recipient_signature_providers = None
 91        self._role_name = None
 92        self._routing_order = None
 93        self._signing_group_id = None
 94        self._tabs = None
 95        self.discriminator = None
 96
 97        setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None))
 98        setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None))
 99        setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None))
100        setattr(self, "_{}".format('default_recipient'), kwargs.get('default_recipient', None))
101        setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None))
102        setattr(self, "_{}".format('email'), kwargs.get('email', None))
103        setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None))
104        setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None))
105        setattr(self, "_{}".format('in_person_signer_name'), kwargs.get('in_person_signer_name', None))
106        setattr(self, "_{}".format('name'), kwargs.get('name', None))
107        setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None))
108        setattr(self, "_{}".format('recipient_signature_providers'), kwargs.get('recipient_signature_providers', None))
109        setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None))
110        setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None))
111        setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None))
112        setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None))
113
114    @property
115    def access_code(self):
116        """Gets the access_code of this TemplateRole.  # noqa: E501
117
118        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
119
120        :return: The access_code of this TemplateRole.  # noqa: E501
121        :rtype: str
122        """
123        return self._access_code
124
125    @access_code.setter
126    def access_code(self, access_code):
127        """Sets the access_code of this TemplateRole.
128
129        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
130
131        :param access_code: The access_code of this TemplateRole.  # noqa: E501
132        :type: str
133        """
134
135        self._access_code = access_code
136
137    @property
138    def additional_notifications(self):
139        """Gets the additional_notifications of this TemplateRole.  # noqa: E501
140
141          # noqa: E501
142
143        :return: The additional_notifications of this TemplateRole.  # noqa: E501
144        :rtype: list[RecipientAdditionalNotification]
145        """
146        return self._additional_notifications
147
148    @additional_notifications.setter
149    def additional_notifications(self, additional_notifications):
150        """Sets the additional_notifications of this TemplateRole.
151
152          # noqa: E501
153
154        :param additional_notifications: The additional_notifications of this TemplateRole.  # noqa: E501
155        :type: list[RecipientAdditionalNotification]
156        """
157
158        self._additional_notifications = additional_notifications
159
160    @property
161    def client_user_id(self):
162        """Gets the client_user_id of this TemplateRole.  # noqa: E501
163
164        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
165
166        :return: The client_user_id of this TemplateRole.  # noqa: E501
167        :rtype: str
168        """
169        return self._client_user_id
170
171    @client_user_id.setter
172    def client_user_id(self, client_user_id):
173        """Sets the client_user_id of this TemplateRole.
174
175        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
176
177        :param client_user_id: The client_user_id of this TemplateRole.  # noqa: E501
178        :type: str
179        """
180
181        self._client_user_id = client_user_id
182
183    @property
184    def default_recipient(self):
185        """Gets the default_recipient of this TemplateRole.  # noqa: E501
186
187        When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.  # noqa: E501
188
189        :return: The default_recipient of this TemplateRole.  # noqa: E501
190        :rtype: str
191        """
192        return self._default_recipient
193
194    @default_recipient.setter
195    def default_recipient(self, default_recipient):
196        """Sets the default_recipient of this TemplateRole.
197
198        When set to **true**, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.  # noqa: E501
199
200        :param default_recipient: The default_recipient of this TemplateRole.  # noqa: E501
201        :type: str
202        """
203
204        self._default_recipient = default_recipient
205
206    @property
207    def delivery_method(self):
208        """Gets the delivery_method of this TemplateRole.  # noqa: E501
209
210        Reserved: For DocuSign use only.  # noqa: E501
211
212        :return: The delivery_method of this TemplateRole.  # noqa: E501
213        :rtype: str
214        """
215        return self._delivery_method
216
217    @delivery_method.setter
218    def delivery_method(self, delivery_method):
219        """Sets the delivery_method of this TemplateRole.
220
221        Reserved: For DocuSign use only.  # noqa: E501
222
223        :param delivery_method: The delivery_method of this TemplateRole.  # noqa: E501
224        :type: str
225        """
226
227        self._delivery_method = delivery_method
228
229    @property
230    def email(self):
231        """Gets the email of this TemplateRole.  # noqa: E501
232
233        Specifies the email associated with a role name.  # noqa: E501
234
235        :return: The email of this TemplateRole.  # noqa: E501
236        :rtype: str
237        """
238        return self._email
239
240    @email.setter
241    def email(self, email):
242        """Sets the email of this TemplateRole.
243
244        Specifies the email associated with a role name.  # noqa: E501
245
246        :param email: The email of this TemplateRole.  # noqa: E501
247        :type: str
248        """
249
250        self._email = email
251
252    @property
253    def email_notification(self):
254        """Gets the email_notification of this TemplateRole.  # noqa: E501
255
256        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
257
258        :return: The email_notification of this TemplateRole.  # noqa: E501
259        :rtype: RecipientEmailNotification
260        """
261        return self._email_notification
262
263    @email_notification.setter
264    def email_notification(self, email_notification):
265        """Sets the email_notification of this TemplateRole.
266
267        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
268
269        :param email_notification: The email_notification of this TemplateRole.  # noqa: E501
270        :type: RecipientEmailNotification
271        """
272
273        self._email_notification = email_notification
274
275    @property
276    def embedded_recipient_start_url(self):
277        """Gets the embedded_recipient_start_url of this TemplateRole.  # noqa: E501
278
279        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
280
281        :return: The embedded_recipient_start_url of this TemplateRole.  # noqa: E501
282        :rtype: str
283        """
284        return self._embedded_recipient_start_url
285
286    @embedded_recipient_start_url.setter
287    def embedded_recipient_start_url(self, embedded_recipient_start_url):
288        """Sets the embedded_recipient_start_url of this TemplateRole.
289
290        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
291
292        :param embedded_recipient_start_url: The embedded_recipient_start_url of this TemplateRole.  # noqa: E501
293        :type: str
294        """
295
296        self._embedded_recipient_start_url = embedded_recipient_start_url
297
298    @property
299    def in_person_signer_name(self):
300        """Gets the in_person_signer_name of this TemplateRole.  # noqa: E501
301
302        Specifies the full legal name of the signer in person signer template roles.  Maximum Length: 100 characters.  # noqa: E501
303
304        :return: The in_person_signer_name of this TemplateRole.  # noqa: E501
305        :rtype: str
306        """
307        return self._in_person_signer_name
308
309    @in_person_signer_name.setter
310    def in_person_signer_name(self, in_person_signer_name):
311        """Sets the in_person_signer_name of this TemplateRole.
312
313        Specifies the full legal name of the signer in person signer template roles.  Maximum Length: 100 characters.  # noqa: E501
314
315        :param in_person_signer_name: The in_person_signer_name of this TemplateRole.  # noqa: E501
316        :type: str
317        """
318
319        self._in_person_signer_name = in_person_signer_name
320
321    @property
322    def name(self):
323        """Gets the name of this TemplateRole.  # noqa: E501
324
325        Specifies the recipient's name.  # noqa: E501
326
327        :return: The name of this TemplateRole.  # noqa: E501
328        :rtype: str
329        """
330        return self._name
331
332    @name.setter
333    def name(self, name):
334        """Sets the name of this TemplateRole.
335
336        Specifies the recipient's name.  # noqa: E501
337
338        :param name: The name of this TemplateRole.  # noqa: E501
339        :type: str
340        """
341
342        self._name = name
343
344    @property
345    def phone_number(self):
346        """Gets the phone_number of this TemplateRole.  # noqa: E501
347
348        Describes the recipient phone number.  # noqa: E501
349
350        :return: The phone_number of this TemplateRole.  # noqa: E501
351        :rtype: RecipientPhoneNumber
352        """
353        return self._phone_number
354
355    @phone_number.setter
356    def phone_number(self, phone_number):
357        """Sets the phone_number of this TemplateRole.
358
359        Describes the recipient phone number.  # noqa: E501
360
361        :param phone_number: The phone_number of this TemplateRole.  # noqa: E501
362        :type: RecipientPhoneNumber
363        """
364
365        self._phone_number = phone_number
366
367    @property
368    def recipient_signature_providers(self):
369        """Gets the recipient_signature_providers of this TemplateRole.  # noqa: E501
370
371          # noqa: E501
372
373        :return: The recipient_signature_providers of this TemplateRole.  # noqa: E501
374        :rtype: list[RecipientSignatureProvider]
375        """
376        return self._recipient_signature_providers
377
378    @recipient_signature_providers.setter
379    def recipient_signature_providers(self, recipient_signature_providers):
380        """Sets the recipient_signature_providers of this TemplateRole.
381
382          # noqa: E501
383
384        :param recipient_signature_providers: The recipient_signature_providers of this TemplateRole.  # noqa: E501
385        :type: list[RecipientSignatureProvider]
386        """
387
388        self._recipient_signature_providers = recipient_signature_providers
389
390    @property
391    def role_name(self):
392        """Gets the role_name of this TemplateRole.  # noqa: E501
393
394        Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.  # noqa: E501
395
396        :return: The role_name of this TemplateRole.  # noqa: E501
397        :rtype: str
398        """
399        return self._role_name
400
401    @role_name.setter
402    def role_name(self, role_name):
403        """Sets the role_name of this TemplateRole.
404
405        Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.  # noqa: E501
406
407        :param role_name: The role_name of this TemplateRole.  # noqa: E501
408        :type: str
409        """
410
411        self._role_name = role_name
412
413    @property
414    def routing_order(self):
415        """Gets the routing_order of this TemplateRole.  # noqa: E501
416
417        Specifies the routing order of the recipient in the envelope.   # noqa: E501
418
419        :return: The routing_order of this TemplateRole.  # noqa: E501
420        :rtype: str
421        """
422        return self._routing_order
423
424    @routing_order.setter
425    def routing_order(self, routing_order):
426        """Sets the routing_order of this TemplateRole.
427
428        Specifies the routing order of the recipient in the envelope.   # noqa: E501
429
430        :param routing_order: The routing_order of this TemplateRole.  # noqa: E501
431        :type: str
432        """
433
434        self._routing_order = routing_order
435
436    @property
437    def signing_group_id(self):
438        """Gets the signing_group_id of this TemplateRole.  # noqa: E501
439
440        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
441
442        :return: The signing_group_id of this TemplateRole.  # noqa: E501
443        :rtype: str
444        """
445        return self._signing_group_id
446
447    @signing_group_id.setter
448    def signing_group_id(self, signing_group_id):
449        """Sets the signing_group_id of this TemplateRole.
450
451        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
452
453        :param signing_group_id: The signing_group_id of this TemplateRole.  # noqa: E501
454        :type: str
455        """
456
457        self._signing_group_id = signing_group_id
458
459    @property
460    def tabs(self):
461        """Gets the tabs of this TemplateRole.  # noqa: E501
462
463        A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.  # noqa: E501
464
465        :return: The tabs of this TemplateRole.  # noqa: E501
466        :rtype: Tabs
467        """
468        return self._tabs
469
470    @tabs.setter
471    def tabs(self, tabs):
472        """Sets the tabs of this TemplateRole.
473
474        A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.  # noqa: E501
475
476        :param tabs: The tabs of this TemplateRole.  # noqa: E501
477        :type: Tabs
478        """
479
480        self._tabs = tabs
481
482    def to_dict(self):
483        """Returns the model properties as a dict"""
484        result = {}
485
486        for attr, _ in six.iteritems(self.swagger_types):
487            value = getattr(self, attr)
488            if isinstance(value, list):
489                result[attr] = list(map(
490                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
491                    value
492                ))
493            elif hasattr(value, "to_dict"):
494                result[attr] = value.to_dict()
495            elif isinstance(value, dict):
496                result[attr] = dict(map(
497                    lambda item: (item[0], item[1].to_dict())
498                    if hasattr(item[1], "to_dict") else item,
499                    value.items()
500                ))
501            else:
502                result[attr] = value
503        if issubclass(TemplateRole, dict):
504            for key, value in self.items():
505                result[key] = value
506
507        return result
508
509    def to_str(self):
510        """Returns the string representation of the model"""
511        return pprint.pformat(self.to_dict())
512
513    def __repr__(self):
514        """For `print` and `pprint`"""
515        return self.to_str()
516
517    def __eq__(self, other):
518        """Returns true if both objects are equal"""
519        if not isinstance(other, TemplateRole):
520            return False
521
522        return self.to_dict() == other.to_dict()
523
524    def __ne__(self, other):
525        """Returns true if both objects are not equal"""
526        if not isinstance(other, TemplateRole):
527            return True
528
529        return self.to_dict() != other.to_dict()