docusign_esign.models.bulk_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 BulkRecipient(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        'email': 'str',
 38        'error_details': 'list[ErrorDetails]',
 39        'identification': 'str',
 40        'name': 'str',
 41        'note': 'str',
 42        'phone_number': 'str',
 43        'recipient_signature_provider_info': 'list[BulkRecipientSignatureProvider]',
 44        'row_number': 'str',
 45        'tab_labels': 'list[BulkRecipientTabLabel]'
 46    }
 47
 48    attribute_map = {
 49        'access_code': 'accessCode',
 50        'email': 'email',
 51        'error_details': 'errorDetails',
 52        'identification': 'identification',
 53        'name': 'name',
 54        'note': 'note',
 55        'phone_number': 'phoneNumber',
 56        'recipient_signature_provider_info': 'recipientSignatureProviderInfo',
 57        'row_number': 'rowNumber',
 58        'tab_labels': 'tabLabels'
 59    }
 60
 61    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 62        """BulkRecipient - a model defined in Swagger"""  # noqa: E501
 63        if _configuration is None:
 64            _configuration = Configuration()
 65        self._configuration = _configuration
 66
 67        self._access_code = None
 68        self._email = None
 69        self._error_details = None
 70        self._identification = None
 71        self._name = None
 72        self._note = None
 73        self._phone_number = None
 74        self._recipient_signature_provider_info = None
 75        self._row_number = None
 76        self._tab_labels = None
 77        self.discriminator = None
 78
 79        setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None))
 80        setattr(self, "_{}".format('email'), kwargs.get('email', None))
 81        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
 82        setattr(self, "_{}".format('identification'), kwargs.get('identification', None))
 83        setattr(self, "_{}".format('name'), kwargs.get('name', None))
 84        setattr(self, "_{}".format('note'), kwargs.get('note', None))
 85        setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None))
 86        setattr(self, "_{}".format('recipient_signature_provider_info'), kwargs.get('recipient_signature_provider_info', None))
 87        setattr(self, "_{}".format('row_number'), kwargs.get('row_number', None))
 88        setattr(self, "_{}".format('tab_labels'), kwargs.get('tab_labels', None))
 89
 90    @property
 91    def access_code(self):
 92        """Gets the access_code of this BulkRecipient.  # noqa: E501
 93
 94        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
 95
 96        :return: The access_code of this BulkRecipient.  # noqa: E501
 97        :rtype: str
 98        """
 99        return self._access_code
100
101    @access_code.setter
102    def access_code(self, access_code):
103        """Sets the access_code of this BulkRecipient.
104
105        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
106
107        :param access_code: The access_code of this BulkRecipient.  # noqa: E501
108        :type: str
109        """
110
111        self._access_code = access_code
112
113    @property
114    def email(self):
115        """Gets the email of this BulkRecipient.  # noqa: E501
116
117        Specifies the recipient's email address.   Maximum length: 100 characters.  # noqa: E501
118
119        :return: The email of this BulkRecipient.  # noqa: E501
120        :rtype: str
121        """
122        return self._email
123
124    @email.setter
125    def email(self, email):
126        """Sets the email of this BulkRecipient.
127
128        Specifies the recipient's email address.   Maximum length: 100 characters.  # noqa: E501
129
130        :param email: The email of this BulkRecipient.  # noqa: E501
131        :type: str
132        """
133
134        self._email = email
135
136    @property
137    def error_details(self):
138        """Gets the error_details of this BulkRecipient.  # noqa: E501
139
140        Array or errors.  # noqa: E501
141
142        :return: The error_details of this BulkRecipient.  # noqa: E501
143        :rtype: list[ErrorDetails]
144        """
145        return self._error_details
146
147    @error_details.setter
148    def error_details(self, error_details):
149        """Sets the error_details of this BulkRecipient.
150
151        Array or errors.  # noqa: E501
152
153        :param error_details: The error_details of this BulkRecipient.  # noqa: E501
154        :type: list[ErrorDetails]
155        """
156
157        self._error_details = error_details
158
159    @property
160    def identification(self):
161        """Gets the identification of this BulkRecipient.  # noqa: E501
162
163        Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer. Only one value can be used in this field.  The acceptable values are:  * KBA: Enables the normal ID check authentication set up for your account. * Phone: Enables phone authentication. * SMS: Enables SMS authentication.  # noqa: E501
164
165        :return: The identification of this BulkRecipient.  # noqa: E501
166        :rtype: str
167        """
168        return self._identification
169
170    @identification.setter
171    def identification(self, identification):
172        """Sets the identification of this BulkRecipient.
173
174        Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer. Only one value can be used in this field.  The acceptable values are:  * KBA: Enables the normal ID check authentication set up for your account. * Phone: Enables phone authentication. * SMS: Enables SMS authentication.  # noqa: E501
175
176        :param identification: The identification of this BulkRecipient.  # noqa: E501
177        :type: str
178        """
179
180        self._identification = identification
181
182    @property
183    def name(self):
184        """Gets the name of this BulkRecipient.  # noqa: E501
185
186        Specifies the recipient's name.   Maximum length: 50 characters.  # noqa: E501
187
188        :return: The name of this BulkRecipient.  # noqa: E501
189        :rtype: str
190        """
191        return self._name
192
193    @name.setter
194    def name(self, name):
195        """Sets the name of this BulkRecipient.
196
197        Specifies the recipient's name.   Maximum length: 50 characters.  # noqa: E501
198
199        :param name: The name of this BulkRecipient.  # noqa: E501
200        :type: str
201        """
202
203        self._name = name
204
205    @property
206    def note(self):
207        """Gets the note of this BulkRecipient.  # noqa: E501
208
209        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
210
211        :return: The note of this BulkRecipient.  # noqa: E501
212        :rtype: str
213        """
214        return self._note
215
216    @note.setter
217    def note(self, note):
218        """Sets the note of this BulkRecipient.
219
220        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
221
222        :param note: The note of this BulkRecipient.  # noqa: E501
223        :type: str
224        """
225
226        self._note = note
227
228    @property
229    def phone_number(self):
230        """Gets the phone_number of this BulkRecipient.  # noqa: E501
231
232        This is only used if the Identification field value is Phone or SMS. The value for this field can be a valid telephone number or, if Phone, usersupplied (SMS authentication cannot use a user supplied number). Parenthesis and dashes can be used in the telephone number.  If `usersupplied` is used, the signer supplies his or her own telephone number.  # noqa: E501
233
234        :return: The phone_number of this BulkRecipient.  # noqa: E501
235        :rtype: str
236        """
237        return self._phone_number
238
239    @phone_number.setter
240    def phone_number(self, phone_number):
241        """Sets the phone_number of this BulkRecipient.
242
243        This is only used if the Identification field value is Phone or SMS. The value for this field can be a valid telephone number or, if Phone, usersupplied (SMS authentication cannot use a user supplied number). Parenthesis and dashes can be used in the telephone number.  If `usersupplied` is used, the signer supplies his or her own telephone number.  # noqa: E501
244
245        :param phone_number: The phone_number of this BulkRecipient.  # noqa: E501
246        :type: str
247        """
248
249        self._phone_number = phone_number
250
251    @property
252    def recipient_signature_provider_info(self):
253        """Gets the recipient_signature_provider_info of this BulkRecipient.  # noqa: E501
254
255          # noqa: E501
256
257        :return: The recipient_signature_provider_info of this BulkRecipient.  # noqa: E501
258        :rtype: list[BulkRecipientSignatureProvider]
259        """
260        return self._recipient_signature_provider_info
261
262    @recipient_signature_provider_info.setter
263    def recipient_signature_provider_info(self, recipient_signature_provider_info):
264        """Sets the recipient_signature_provider_info of this BulkRecipient.
265
266          # noqa: E501
267
268        :param recipient_signature_provider_info: The recipient_signature_provider_info of this BulkRecipient.  # noqa: E501
269        :type: list[BulkRecipientSignatureProvider]
270        """
271
272        self._recipient_signature_provider_info = recipient_signature_provider_info
273
274    @property
275    def row_number(self):
276        """Gets the row_number of this BulkRecipient.  # noqa: E501
277
278          # noqa: E501
279
280        :return: The row_number of this BulkRecipient.  # noqa: E501
281        :rtype: str
282        """
283        return self._row_number
284
285    @row_number.setter
286    def row_number(self, row_number):
287        """Sets the row_number of this BulkRecipient.
288
289          # noqa: E501
290
291        :param row_number: The row_number of this BulkRecipient.  # noqa: E501
292        :type: str
293        """
294
295        self._row_number = row_number
296
297    @property
298    def tab_labels(self):
299        """Gets the tab_labels of this BulkRecipient.  # noqa: E501
300
301        Specifies values used to populate recipient tabs with information. This allows each bulk recipient signer to have different values for their associated tabs. Any number of `tabLabel` columns can be added to the bulk recipient file.  The information used in the bulk recipient file header must be the same as the `tabLabel` for the tab.  The values entered in this column are automatically inserted into the corresponding tab for the recipient in the same row.  Note that this option cannot be used for tabs that do not have data or that are automatically populated data such as Signature, Full Name, Email Address, Company, Title, and Date Signed tabs.  # noqa: E501
302
303        :return: The tab_labels of this BulkRecipient.  # noqa: E501
304        :rtype: list[BulkRecipientTabLabel]
305        """
306        return self._tab_labels
307
308    @tab_labels.setter
309    def tab_labels(self, tab_labels):
310        """Sets the tab_labels of this BulkRecipient.
311
312        Specifies values used to populate recipient tabs with information. This allows each bulk recipient signer to have different values for their associated tabs. Any number of `tabLabel` columns can be added to the bulk recipient file.  The information used in the bulk recipient file header must be the same as the `tabLabel` for the tab.  The values entered in this column are automatically inserted into the corresponding tab for the recipient in the same row.  Note that this option cannot be used for tabs that do not have data or that are automatically populated data such as Signature, Full Name, Email Address, Company, Title, and Date Signed tabs.  # noqa: E501
313
314        :param tab_labels: The tab_labels of this BulkRecipient.  # noqa: E501
315        :type: list[BulkRecipientTabLabel]
316        """
317
318        self._tab_labels = tab_labels
319
320    def to_dict(self):
321        """Returns the model properties as a dict"""
322        result = {}
323
324        for attr, _ in six.iteritems(self.swagger_types):
325            value = getattr(self, attr)
326            if isinstance(value, list):
327                result[attr] = list(map(
328                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
329                    value
330                ))
331            elif hasattr(value, "to_dict"):
332                result[attr] = value.to_dict()
333            elif isinstance(value, dict):
334                result[attr] = dict(map(
335                    lambda item: (item[0], item[1].to_dict())
336                    if hasattr(item[1], "to_dict") else item,
337                    value.items()
338                ))
339            else:
340                result[attr] = value
341        if issubclass(BulkRecipient, dict):
342            for key, value in self.items():
343                result[key] = value
344
345        return result
346
347    def to_str(self):
348        """Returns the string representation of the model"""
349        return pprint.pformat(self.to_dict())
350
351    def __repr__(self):
352        """For `print` and `pprint`"""
353        return self.to_str()
354
355    def __eq__(self, other):
356        """Returns true if both objects are equal"""
357        if not isinstance(other, BulkRecipient):
358            return False
359
360        return self.to_dict() == other.to_dict()
361
362    def __ne__(self, other):
363        """Returns true if both objects are not equal"""
364        if not isinstance(other, BulkRecipient):
365            return True
366
367        return self.to_dict() != other.to_dict()