docusign_esign.models.prefill_tabs

  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 PrefillTabs(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        'checkbox_tabs': 'list[Checkbox]',
 37        'date_tabs': 'list[Date]',
 38        'email_tabs': 'list[Email]',
 39        'number_tabs': 'list[Number]',
 40        'radio_group_tabs': 'list[RadioGroup]',
 41        'sender_company_tabs': 'list[SenderCompany]',
 42        'sender_name_tabs': 'list[SenderName]',
 43        'ssn_tabs': 'list[Ssn]',
 44        'tab_groups': 'list[TabGroup]',
 45        'text_tabs': 'list[Text]',
 46        'zip_tabs': 'list[Zip]'
 47    }
 48
 49    attribute_map = {
 50        'checkbox_tabs': 'checkboxTabs',
 51        'date_tabs': 'dateTabs',
 52        'email_tabs': 'emailTabs',
 53        'number_tabs': 'numberTabs',
 54        'radio_group_tabs': 'radioGroupTabs',
 55        'sender_company_tabs': 'senderCompanyTabs',
 56        'sender_name_tabs': 'senderNameTabs',
 57        'ssn_tabs': 'ssnTabs',
 58        'tab_groups': 'tabGroups',
 59        'text_tabs': 'textTabs',
 60        'zip_tabs': 'zipTabs'
 61    }
 62
 63    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 64        """PrefillTabs - a model defined in Swagger"""  # noqa: E501
 65        if _configuration is None:
 66            _configuration = Configuration()
 67        self._configuration = _configuration
 68
 69        self._checkbox_tabs = None
 70        self._date_tabs = None
 71        self._email_tabs = None
 72        self._number_tabs = None
 73        self._radio_group_tabs = None
 74        self._sender_company_tabs = None
 75        self._sender_name_tabs = None
 76        self._ssn_tabs = None
 77        self._tab_groups = None
 78        self._text_tabs = None
 79        self._zip_tabs = None
 80        self.discriminator = None
 81
 82        setattr(self, "_{}".format('checkbox_tabs'), kwargs.get('checkbox_tabs', None))
 83        setattr(self, "_{}".format('date_tabs'), kwargs.get('date_tabs', None))
 84        setattr(self, "_{}".format('email_tabs'), kwargs.get('email_tabs', None))
 85        setattr(self, "_{}".format('number_tabs'), kwargs.get('number_tabs', None))
 86        setattr(self, "_{}".format('radio_group_tabs'), kwargs.get('radio_group_tabs', None))
 87        setattr(self, "_{}".format('sender_company_tabs'), kwargs.get('sender_company_tabs', None))
 88        setattr(self, "_{}".format('sender_name_tabs'), kwargs.get('sender_name_tabs', None))
 89        setattr(self, "_{}".format('ssn_tabs'), kwargs.get('ssn_tabs', None))
 90        setattr(self, "_{}".format('tab_groups'), kwargs.get('tab_groups', None))
 91        setattr(self, "_{}".format('text_tabs'), kwargs.get('text_tabs', None))
 92        setattr(self, "_{}".format('zip_tabs'), kwargs.get('zip_tabs', None))
 93
 94    @property
 95    def checkbox_tabs(self):
 96        """Gets the checkbox_tabs of this PrefillTabs.  # noqa: E501
 97
 98        Specifies a tag on the document in a location where the recipient can select an option.  # noqa: E501
 99
100        :return: The checkbox_tabs of this PrefillTabs.  # noqa: E501
101        :rtype: list[Checkbox]
102        """
103        return self._checkbox_tabs
104
105    @checkbox_tabs.setter
106    def checkbox_tabs(self, checkbox_tabs):
107        """Sets the checkbox_tabs of this PrefillTabs.
108
109        Specifies a tag on the document in a location where the recipient can select an option.  # noqa: E501
110
111        :param checkbox_tabs: The checkbox_tabs of this PrefillTabs.  # noqa: E501
112        :type: list[Checkbox]
113        """
114
115        self._checkbox_tabs = checkbox_tabs
116
117    @property
118    def date_tabs(self):
119        """Gets the date_tabs of this PrefillTabs.  # noqa: E501
120
121        Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained.   If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format.  # noqa: E501
122
123        :return: The date_tabs of this PrefillTabs.  # noqa: E501
124        :rtype: list[Date]
125        """
126        return self._date_tabs
127
128    @date_tabs.setter
129    def date_tabs(self, date_tabs):
130        """Sets the date_tabs of this PrefillTabs.
131
132        Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained.   If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format.  # noqa: E501
133
134        :param date_tabs: The date_tabs of this PrefillTabs.  # noqa: E501
135        :type: list[Date]
136        """
137
138        self._date_tabs = date_tabs
139
140    @property
141    def email_tabs(self):
142        """Gets the email_tabs of this PrefillTabs.  # noqa: E501
143
144        Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.  # noqa: E501
145
146        :return: The email_tabs of this PrefillTabs.  # noqa: E501
147        :rtype: list[Email]
148        """
149        return self._email_tabs
150
151    @email_tabs.setter
152    def email_tabs(self, email_tabs):
153        """Sets the email_tabs of this PrefillTabs.
154
155        Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.  # noqa: E501
156
157        :param email_tabs: The email_tabs of this PrefillTabs.  # noqa: E501
158        :type: list[Email]
159        """
160
161        self._email_tabs = email_tabs
162
163    @property
164    def number_tabs(self):
165        """Gets the number_tabs of this PrefillTabs.  # noqa: E501
166
167        Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.   # noqa: E501
168
169        :return: The number_tabs of this PrefillTabs.  # noqa: E501
170        :rtype: list[Number]
171        """
172        return self._number_tabs
173
174    @number_tabs.setter
175    def number_tabs(self, number_tabs):
176        """Sets the number_tabs of this PrefillTabs.
177
178        Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.   # noqa: E501
179
180        :param number_tabs: The number_tabs of this PrefillTabs.  # noqa: E501
181        :type: list[Number]
182        """
183
184        self._number_tabs = number_tabs
185
186    @property
187    def radio_group_tabs(self):
188        """Gets the radio_group_tabs of this PrefillTabs.  # noqa: E501
189
190        Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document.  # noqa: E501
191
192        :return: The radio_group_tabs of this PrefillTabs.  # noqa: E501
193        :rtype: list[RadioGroup]
194        """
195        return self._radio_group_tabs
196
197    @radio_group_tabs.setter
198    def radio_group_tabs(self, radio_group_tabs):
199        """Sets the radio_group_tabs of this PrefillTabs.
200
201        Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document.  # noqa: E501
202
203        :param radio_group_tabs: The radio_group_tabs of this PrefillTabs.  # noqa: E501
204        :type: list[RadioGroup]
205        """
206
207        self._radio_group_tabs = radio_group_tabs
208
209    @property
210    def sender_company_tabs(self):
211        """Gets the sender_company_tabs of this PrefillTabs.  # noqa: E501
212
213          # noqa: E501
214
215        :return: The sender_company_tabs of this PrefillTabs.  # noqa: E501
216        :rtype: list[SenderCompany]
217        """
218        return self._sender_company_tabs
219
220    @sender_company_tabs.setter
221    def sender_company_tabs(self, sender_company_tabs):
222        """Sets the sender_company_tabs of this PrefillTabs.
223
224          # noqa: E501
225
226        :param sender_company_tabs: The sender_company_tabs of this PrefillTabs.  # noqa: E501
227        :type: list[SenderCompany]
228        """
229
230        self._sender_company_tabs = sender_company_tabs
231
232    @property
233    def sender_name_tabs(self):
234        """Gets the sender_name_tabs of this PrefillTabs.  # noqa: E501
235
236          # noqa: E501
237
238        :return: The sender_name_tabs of this PrefillTabs.  # noqa: E501
239        :rtype: list[SenderName]
240        """
241        return self._sender_name_tabs
242
243    @sender_name_tabs.setter
244    def sender_name_tabs(self, sender_name_tabs):
245        """Sets the sender_name_tabs of this PrefillTabs.
246
247          # noqa: E501
248
249        :param sender_name_tabs: The sender_name_tabs of this PrefillTabs.  # noqa: E501
250        :type: list[SenderName]
251        """
252
253        self._sender_name_tabs = sender_name_tabs
254
255    @property
256    def ssn_tabs(self):
257        """Gets the ssn_tabs of this PrefillTabs.  # noqa: E501
258
259        Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.  # noqa: E501
260
261        :return: The ssn_tabs of this PrefillTabs.  # noqa: E501
262        :rtype: list[Ssn]
263        """
264        return self._ssn_tabs
265
266    @ssn_tabs.setter
267    def ssn_tabs(self, ssn_tabs):
268        """Sets the ssn_tabs of this PrefillTabs.
269
270        Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.  # noqa: E501
271
272        :param ssn_tabs: The ssn_tabs of this PrefillTabs.  # noqa: E501
273        :type: list[Ssn]
274        """
275
276        self._ssn_tabs = ssn_tabs
277
278    @property
279    def tab_groups(self):
280        """Gets the tab_groups of this PrefillTabs.  # noqa: E501
281
282          # noqa: E501
283
284        :return: The tab_groups of this PrefillTabs.  # noqa: E501
285        :rtype: list[TabGroup]
286        """
287        return self._tab_groups
288
289    @tab_groups.setter
290    def tab_groups(self, tab_groups):
291        """Sets the tab_groups of this PrefillTabs.
292
293          # noqa: E501
294
295        :param tab_groups: The tab_groups of this PrefillTabs.  # noqa: E501
296        :type: list[TabGroup]
297        """
298
299        self._tab_groups = tab_groups
300
301    @property
302    def text_tabs(self):
303        """Gets the text_tabs of this PrefillTabs.  # noqa: E501
304
305        Specifies a that that is an adaptable field that allows the recipient to enter different text information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.  # noqa: E501
306
307        :return: The text_tabs of this PrefillTabs.  # noqa: E501
308        :rtype: list[Text]
309        """
310        return self._text_tabs
311
312    @text_tabs.setter
313    def text_tabs(self, text_tabs):
314        """Sets the text_tabs of this PrefillTabs.
315
316        Specifies a that that is an adaptable field that allows the recipient to enter different text information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.  # noqa: E501
317
318        :param text_tabs: The text_tabs of this PrefillTabs.  # noqa: E501
319        :type: list[Text]
320        """
321
322        self._text_tabs = text_tabs
323
324    @property
325    def zip_tabs(self):
326        """Gets the zip_tabs of this PrefillTabs.  # noqa: E501
327
328        Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.  # noqa: E501
329
330        :return: The zip_tabs of this PrefillTabs.  # noqa: E501
331        :rtype: list[Zip]
332        """
333        return self._zip_tabs
334
335    @zip_tabs.setter
336    def zip_tabs(self, zip_tabs):
337        """Sets the zip_tabs of this PrefillTabs.
338
339        Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.  # noqa: E501
340
341        :param zip_tabs: The zip_tabs of this PrefillTabs.  # noqa: E501
342        :type: list[Zip]
343        """
344
345        self._zip_tabs = zip_tabs
346
347    def to_dict(self):
348        """Returns the model properties as a dict"""
349        result = {}
350
351        for attr, _ in six.iteritems(self.swagger_types):
352            value = getattr(self, attr)
353            if isinstance(value, list):
354                result[attr] = list(map(
355                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
356                    value
357                ))
358            elif hasattr(value, "to_dict"):
359                result[attr] = value.to_dict()
360            elif isinstance(value, dict):
361                result[attr] = dict(map(
362                    lambda item: (item[0], item[1].to_dict())
363                    if hasattr(item[1], "to_dict") else item,
364                    value.items()
365                ))
366            else:
367                result[attr] = value
368        if issubclass(PrefillTabs, dict):
369            for key, value in self.items():
370                result[key] = value
371
372        return result
373
374    def to_str(self):
375        """Returns the string representation of the model"""
376        return pprint.pformat(self.to_dict())
377
378    def __repr__(self):
379        """For `print` and `pprint`"""
380        return self.to_str()
381
382    def __eq__(self, other):
383        """Returns true if both objects are equal"""
384        if not isinstance(other, PrefillTabs):
385            return False
386
387        return self.to_dict() == other.to_dict()
388
389    def __ne__(self, other):
390        """Returns true if both objects are not equal"""
391        if not isinstance(other, PrefillTabs):
392            return True
393
394        return self.to_dict() != other.to_dict()