docusign_esign.models.doc_gen_form_field

  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 DocGenFormField(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        'description': 'str',
 37        'label': 'str',
 38        'name': 'str',
 39        'options': 'list[DocGenFormFieldOption]',
 40        'predefined_validation': 'str',
 41        'required': 'str',
 42        'row_values': 'list[DocGenFormFieldRowValue]',
 43        'type': 'str',
 44        'validation': 'DocGenFormFieldValidation',
 45        'value': 'str'
 46    }
 47
 48    attribute_map = {
 49        'description': 'description',
 50        'label': 'label',
 51        'name': 'name',
 52        'options': 'options',
 53        'predefined_validation': 'predefinedValidation',
 54        'required': 'required',
 55        'row_values': 'rowValues',
 56        'type': 'type',
 57        'validation': 'validation',
 58        'value': 'value'
 59    }
 60
 61    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 62        """DocGenFormField - a model defined in Swagger"""  # noqa: E501
 63        if _configuration is None:
 64            _configuration = Configuration()
 65        self._configuration = _configuration
 66
 67        self._description = None
 68        self._label = None
 69        self._name = None
 70        self._options = None
 71        self._predefined_validation = None
 72        self._required = None
 73        self._row_values = None
 74        self._type = None
 75        self._validation = None
 76        self._value = None
 77        self.discriminator = None
 78
 79        setattr(self, "_{}".format('description'), kwargs.get('description', None))
 80        setattr(self, "_{}".format('label'), kwargs.get('label', None))
 81        setattr(self, "_{}".format('name'), kwargs.get('name', None))
 82        setattr(self, "_{}".format('options'), kwargs.get('options', None))
 83        setattr(self, "_{}".format('predefined_validation'), kwargs.get('predefined_validation', None))
 84        setattr(self, "_{}".format('required'), kwargs.get('required', None))
 85        setattr(self, "_{}".format('row_values'), kwargs.get('row_values', None))
 86        setattr(self, "_{}".format('type'), kwargs.get('type', None))
 87        setattr(self, "_{}".format('validation'), kwargs.get('validation', None))
 88        setattr(self, "_{}".format('value'), kwargs.get('value', None))
 89
 90    @property
 91    def description(self):
 92        """Gets the description of this DocGenFormField.  # noqa: E501
 93
 94          # noqa: E501
 95
 96        :return: The description of this DocGenFormField.  # noqa: E501
 97        :rtype: str
 98        """
 99        return self._description
100
101    @description.setter
102    def description(self, description):
103        """Sets the description of this DocGenFormField.
104
105          # noqa: E501
106
107        :param description: The description of this DocGenFormField.  # noqa: E501
108        :type: str
109        """
110
111        self._description = description
112
113    @property
114    def label(self):
115        """Gets the label of this DocGenFormField.  # noqa: E501
116
117          # noqa: E501
118
119        :return: The label of this DocGenFormField.  # noqa: E501
120        :rtype: str
121        """
122        return self._label
123
124    @label.setter
125    def label(self, label):
126        """Sets the label of this DocGenFormField.
127
128          # noqa: E501
129
130        :param label: The label of this DocGenFormField.  # noqa: E501
131        :type: str
132        """
133
134        self._label = label
135
136    @property
137    def name(self):
138        """Gets the name of this DocGenFormField.  # noqa: E501
139
140          # noqa: E501
141
142        :return: The name of this DocGenFormField.  # noqa: E501
143        :rtype: str
144        """
145        return self._name
146
147    @name.setter
148    def name(self, name):
149        """Sets the name of this DocGenFormField.
150
151          # noqa: E501
152
153        :param name: The name of this DocGenFormField.  # noqa: E501
154        :type: str
155        """
156
157        self._name = name
158
159    @property
160    def options(self):
161        """Gets the options of this DocGenFormField.  # noqa: E501
162
163          # noqa: E501
164
165        :return: The options of this DocGenFormField.  # noqa: E501
166        :rtype: list[DocGenFormFieldOption]
167        """
168        return self._options
169
170    @options.setter
171    def options(self, options):
172        """Sets the options of this DocGenFormField.
173
174          # noqa: E501
175
176        :param options: The options of this DocGenFormField.  # noqa: E501
177        :type: list[DocGenFormFieldOption]
178        """
179
180        self._options = options
181
182    @property
183    def predefined_validation(self):
184        """Gets the predefined_validation of this DocGenFormField.  # noqa: E501
185
186          # noqa: E501
187
188        :return: The predefined_validation of this DocGenFormField.  # noqa: E501
189        :rtype: str
190        """
191        return self._predefined_validation
192
193    @predefined_validation.setter
194    def predefined_validation(self, predefined_validation):
195        """Sets the predefined_validation of this DocGenFormField.
196
197          # noqa: E501
198
199        :param predefined_validation: The predefined_validation of this DocGenFormField.  # noqa: E501
200        :type: str
201        """
202
203        self._predefined_validation = predefined_validation
204
205    @property
206    def required(self):
207        """Gets the required of this DocGenFormField.  # noqa: E501
208
209        When set to **true**, the signer is required to fill out this tab  # noqa: E501
210
211        :return: The required of this DocGenFormField.  # noqa: E501
212        :rtype: str
213        """
214        return self._required
215
216    @required.setter
217    def required(self, required):
218        """Sets the required of this DocGenFormField.
219
220        When set to **true**, the signer is required to fill out this tab  # noqa: E501
221
222        :param required: The required of this DocGenFormField.  # noqa: E501
223        :type: str
224        """
225
226        self._required = required
227
228    @property
229    def row_values(self):
230        """Gets the row_values of this DocGenFormField.  # noqa: E501
231
232          # noqa: E501
233
234        :return: The row_values of this DocGenFormField.  # noqa: E501
235        :rtype: list[DocGenFormFieldRowValue]
236        """
237        return self._row_values
238
239    @row_values.setter
240    def row_values(self, row_values):
241        """Sets the row_values of this DocGenFormField.
242
243          # noqa: E501
244
245        :param row_values: The row_values of this DocGenFormField.  # noqa: E501
246        :type: list[DocGenFormFieldRowValue]
247        """
248
249        self._row_values = row_values
250
251    @property
252    def type(self):
253        """Gets the type of this DocGenFormField.  # noqa: E501
254
255          # noqa: E501
256
257        :return: The type of this DocGenFormField.  # noqa: E501
258        :rtype: str
259        """
260        return self._type
261
262    @type.setter
263    def type(self, type):
264        """Sets the type of this DocGenFormField.
265
266          # noqa: E501
267
268        :param type: The type of this DocGenFormField.  # noqa: E501
269        :type: str
270        """
271
272        self._type = type
273
274    @property
275    def validation(self):
276        """Gets the validation of this DocGenFormField.  # noqa: E501
277
278          # noqa: E501
279
280        :return: The validation of this DocGenFormField.  # noqa: E501
281        :rtype: DocGenFormFieldValidation
282        """
283        return self._validation
284
285    @validation.setter
286    def validation(self, validation):
287        """Sets the validation of this DocGenFormField.
288
289          # noqa: E501
290
291        :param validation: The validation of this DocGenFormField.  # noqa: E501
292        :type: DocGenFormFieldValidation
293        """
294
295        self._validation = validation
296
297    @property
298    def value(self):
299        """Gets the value of this DocGenFormField.  # noqa: E501
300
301        Specifies the value of the tab.   # noqa: E501
302
303        :return: The value of this DocGenFormField.  # noqa: E501
304        :rtype: str
305        """
306        return self._value
307
308    @value.setter
309    def value(self, value):
310        """Sets the value of this DocGenFormField.
311
312        Specifies the value of the tab.   # noqa: E501
313
314        :param value: The value of this DocGenFormField.  # noqa: E501
315        :type: str
316        """
317
318        self._value = value
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(DocGenFormField, 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, DocGenFormField):
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, DocGenFormField):
365            return True
366
367        return self.to_dict() != other.to_dict()