docusign_esign.models.doc_gen_form_field

Docusign eSignature REST API

The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501

OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git

  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        'connected_object_details': 'ConnectedObjectDetails',
 37        'description': 'str',
 38        'format': 'DocGenFormat',
 39        'fully_qualified_path': 'str',
 40        'hidden': 'str',
 41        'label': 'str',
 42        'name': 'str',
 43        'options': 'list[DocGenFormFieldOption]',
 44        'order': 'str',
 45        'predefined_validation': 'str',
 46        'read_only': 'str',
 47        'required': 'str',
 48        'row_values': 'list[DocGenFormFieldRowValue]',
 49        'type': 'str',
 50        'validation': 'DocGenFormFieldValidation',
 51        'value': 'str'
 52    }
 53
 54    attribute_map = {
 55        'connected_object_details': 'connectedObjectDetails',
 56        'description': 'description',
 57        'format': 'format',
 58        'fully_qualified_path': 'fullyQualifiedPath',
 59        'hidden': 'hidden',
 60        'label': 'label',
 61        'name': 'name',
 62        'options': 'options',
 63        'order': 'order',
 64        'predefined_validation': 'predefinedValidation',
 65        'read_only': 'readOnly',
 66        'required': 'required',
 67        'row_values': 'rowValues',
 68        'type': 'type',
 69        'validation': 'validation',
 70        'value': 'value'
 71    }
 72
 73    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 74        """DocGenFormField - a model defined in Swagger"""  # noqa: E501
 75        if _configuration is None:
 76            _configuration = Configuration()
 77        self._configuration = _configuration
 78
 79        self._connected_object_details = None
 80        self._description = None
 81        self._format = None
 82        self._fully_qualified_path = None
 83        self._hidden = None
 84        self._label = None
 85        self._name = None
 86        self._options = None
 87        self._order = None
 88        self._predefined_validation = None
 89        self._read_only = None
 90        self._required = None
 91        self._row_values = None
 92        self._type = None
 93        self._validation = None
 94        self._value = None
 95        self.discriminator = None
 96
 97        setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None))
 98        setattr(self, "_{}".format('description'), kwargs.get('description', None))
 99        setattr(self, "_{}".format('format'), kwargs.get('format', None))
100        setattr(self, "_{}".format('fully_qualified_path'), kwargs.get('fully_qualified_path', None))
101        setattr(self, "_{}".format('hidden'), kwargs.get('hidden', None))
102        setattr(self, "_{}".format('label'), kwargs.get('label', None))
103        setattr(self, "_{}".format('name'), kwargs.get('name', None))
104        setattr(self, "_{}".format('options'), kwargs.get('options', None))
105        setattr(self, "_{}".format('order'), kwargs.get('order', None))
106        setattr(self, "_{}".format('predefined_validation'), kwargs.get('predefined_validation', None))
107        setattr(self, "_{}".format('read_only'), kwargs.get('read_only', None))
108        setattr(self, "_{}".format('required'), kwargs.get('required', None))
109        setattr(self, "_{}".format('row_values'), kwargs.get('row_values', None))
110        setattr(self, "_{}".format('type'), kwargs.get('type', None))
111        setattr(self, "_{}".format('validation'), kwargs.get('validation', None))
112        setattr(self, "_{}".format('value'), kwargs.get('value', None))
113
114    @property
115    def connected_object_details(self):
116        """Gets the connected_object_details of this DocGenFormField.  # noqa: E501
117
118          # noqa: E501
119
120        :return: The connected_object_details of this DocGenFormField.  # noqa: E501
121        :rtype: ConnectedObjectDetails
122        """
123        return self._connected_object_details
124
125    @connected_object_details.setter
126    def connected_object_details(self, connected_object_details):
127        """Sets the connected_object_details of this DocGenFormField.
128
129          # noqa: E501
130
131        :param connected_object_details: The connected_object_details of this DocGenFormField.  # noqa: E501
132        :type: ConnectedObjectDetails
133        """
134
135        self._connected_object_details = connected_object_details
136
137    @property
138    def description(self):
139        """Gets the description of this DocGenFormField.  # noqa: E501
140
141          # noqa: E501
142
143        :return: The description of this DocGenFormField.  # noqa: E501
144        :rtype: str
145        """
146        return self._description
147
148    @description.setter
149    def description(self, description):
150        """Sets the description of this DocGenFormField.
151
152          # noqa: E501
153
154        :param description: The description of this DocGenFormField.  # noqa: E501
155        :type: str
156        """
157
158        self._description = description
159
160    @property
161    def format(self):
162        """Gets the format of this DocGenFormField.  # noqa: E501
163
164          # noqa: E501
165
166        :return: The format of this DocGenFormField.  # noqa: E501
167        :rtype: DocGenFormat
168        """
169        return self._format
170
171    @format.setter
172    def format(self, format):
173        """Sets the format of this DocGenFormField.
174
175          # noqa: E501
176
177        :param format: The format of this DocGenFormField.  # noqa: E501
178        :type: DocGenFormat
179        """
180
181        self._format = format
182
183    @property
184    def fully_qualified_path(self):
185        """Gets the fully_qualified_path of this DocGenFormField.  # noqa: E501
186
187          # noqa: E501
188
189        :return: The fully_qualified_path of this DocGenFormField.  # noqa: E501
190        :rtype: str
191        """
192        return self._fully_qualified_path
193
194    @fully_qualified_path.setter
195    def fully_qualified_path(self, fully_qualified_path):
196        """Sets the fully_qualified_path of this DocGenFormField.
197
198          # noqa: E501
199
200        :param fully_qualified_path: The fully_qualified_path of this DocGenFormField.  # noqa: E501
201        :type: str
202        """
203
204        self._fully_qualified_path = fully_qualified_path
205
206    @property
207    def hidden(self):
208        """Gets the hidden of this DocGenFormField.  # noqa: E501
209
210          # noqa: E501
211
212        :return: The hidden of this DocGenFormField.  # noqa: E501
213        :rtype: str
214        """
215        return self._hidden
216
217    @hidden.setter
218    def hidden(self, hidden):
219        """Sets the hidden of this DocGenFormField.
220
221          # noqa: E501
222
223        :param hidden: The hidden of this DocGenFormField.  # noqa: E501
224        :type: str
225        """
226
227        self._hidden = hidden
228
229    @property
230    def label(self):
231        """Gets the label of this DocGenFormField.  # noqa: E501
232
233          # noqa: E501
234
235        :return: The label of this DocGenFormField.  # noqa: E501
236        :rtype: str
237        """
238        return self._label
239
240    @label.setter
241    def label(self, label):
242        """Sets the label of this DocGenFormField.
243
244          # noqa: E501
245
246        :param label: The label of this DocGenFormField.  # noqa: E501
247        :type: str
248        """
249
250        self._label = label
251
252    @property
253    def name(self):
254        """Gets the name of this DocGenFormField.  # noqa: E501
255
256          # noqa: E501
257
258        :return: The name of this DocGenFormField.  # noqa: E501
259        :rtype: str
260        """
261        return self._name
262
263    @name.setter
264    def name(self, name):
265        """Sets the name of this DocGenFormField.
266
267          # noqa: E501
268
269        :param name: The name of this DocGenFormField.  # noqa: E501
270        :type: str
271        """
272
273        self._name = name
274
275    @property
276    def options(self):
277        """Gets the options of this DocGenFormField.  # noqa: E501
278
279          # noqa: E501
280
281        :return: The options of this DocGenFormField.  # noqa: E501
282        :rtype: list[DocGenFormFieldOption]
283        """
284        return self._options
285
286    @options.setter
287    def options(self, options):
288        """Sets the options of this DocGenFormField.
289
290          # noqa: E501
291
292        :param options: The options of this DocGenFormField.  # noqa: E501
293        :type: list[DocGenFormFieldOption]
294        """
295
296        self._options = options
297
298    @property
299    def order(self):
300        """Gets the order of this DocGenFormField.  # noqa: E501
301
302          # noqa: E501
303
304        :return: The order of this DocGenFormField.  # noqa: E501
305        :rtype: str
306        """
307        return self._order
308
309    @order.setter
310    def order(self, order):
311        """Sets the order of this DocGenFormField.
312
313          # noqa: E501
314
315        :param order: The order of this DocGenFormField.  # noqa: E501
316        :type: str
317        """
318
319        self._order = order
320
321    @property
322    def predefined_validation(self):
323        """Gets the predefined_validation of this DocGenFormField.  # noqa: E501
324
325          # noqa: E501
326
327        :return: The predefined_validation of this DocGenFormField.  # noqa: E501
328        :rtype: str
329        """
330        return self._predefined_validation
331
332    @predefined_validation.setter
333    def predefined_validation(self, predefined_validation):
334        """Sets the predefined_validation of this DocGenFormField.
335
336          # noqa: E501
337
338        :param predefined_validation: The predefined_validation of this DocGenFormField.  # noqa: E501
339        :type: str
340        """
341
342        self._predefined_validation = predefined_validation
343
344    @property
345    def read_only(self):
346        """Gets the read_only of this DocGenFormField.  # noqa: E501
347
348          # noqa: E501
349
350        :return: The read_only of this DocGenFormField.  # noqa: E501
351        :rtype: str
352        """
353        return self._read_only
354
355    @read_only.setter
356    def read_only(self, read_only):
357        """Sets the read_only of this DocGenFormField.
358
359          # noqa: E501
360
361        :param read_only: The read_only of this DocGenFormField.  # noqa: E501
362        :type: str
363        """
364
365        self._read_only = read_only
366
367    @property
368    def required(self):
369        """Gets the required of this DocGenFormField.  # noqa: E501
370
371        When set to **true**, the signer is required to fill out this tab  # noqa: E501
372
373        :return: The required of this DocGenFormField.  # noqa: E501
374        :rtype: str
375        """
376        return self._required
377
378    @required.setter
379    def required(self, required):
380        """Sets the required of this DocGenFormField.
381
382        When set to **true**, the signer is required to fill out this tab  # noqa: E501
383
384        :param required: The required of this DocGenFormField.  # noqa: E501
385        :type: str
386        """
387
388        self._required = required
389
390    @property
391    def row_values(self):
392        """Gets the row_values of this DocGenFormField.  # noqa: E501
393
394          # noqa: E501
395
396        :return: The row_values of this DocGenFormField.  # noqa: E501
397        :rtype: list[DocGenFormFieldRowValue]
398        """
399        return self._row_values
400
401    @row_values.setter
402    def row_values(self, row_values):
403        """Sets the row_values of this DocGenFormField.
404
405          # noqa: E501
406
407        :param row_values: The row_values of this DocGenFormField.  # noqa: E501
408        :type: list[DocGenFormFieldRowValue]
409        """
410
411        self._row_values = row_values
412
413    @property
414    def type(self):
415        """Gets the type of this DocGenFormField.  # noqa: E501
416
417          # noqa: E501
418
419        :return: The type of this DocGenFormField.  # noqa: E501
420        :rtype: str
421        """
422        return self._type
423
424    @type.setter
425    def type(self, type):
426        """Sets the type of this DocGenFormField.
427
428          # noqa: E501
429
430        :param type: The type of this DocGenFormField.  # noqa: E501
431        :type: str
432        """
433
434        self._type = type
435
436    @property
437    def validation(self):
438        """Gets the validation of this DocGenFormField.  # noqa: E501
439
440          # noqa: E501
441
442        :return: The validation of this DocGenFormField.  # noqa: E501
443        :rtype: DocGenFormFieldValidation
444        """
445        return self._validation
446
447    @validation.setter
448    def validation(self, validation):
449        """Sets the validation of this DocGenFormField.
450
451          # noqa: E501
452
453        :param validation: The validation of this DocGenFormField.  # noqa: E501
454        :type: DocGenFormFieldValidation
455        """
456
457        self._validation = validation
458
459    @property
460    def value(self):
461        """Gets the value of this DocGenFormField.  # noqa: E501
462
463        Specifies the value of the tab.   # noqa: E501
464
465        :return: The value of this DocGenFormField.  # noqa: E501
466        :rtype: str
467        """
468        return self._value
469
470    @value.setter
471    def value(self, value):
472        """Sets the value of this DocGenFormField.
473
474        Specifies the value of the tab.   # noqa: E501
475
476        :param value: The value of this DocGenFormField.  # noqa: E501
477        :type: str
478        """
479
480        self._value = value
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(DocGenFormField, 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, DocGenFormField):
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, DocGenFormField):
527            return True
528
529        return self.to_dict() != other.to_dict()
class DocGenFormField:
 23class DocGenFormField(object):
 24    """NOTE: This class is auto generated by the swagger code generator program.
 25
 26    Do not edit the class manually.
 27    """
 28
 29    """
 30    Attributes:
 31      swagger_types (dict): The key is attribute name
 32                            and the value is attribute type.
 33      attribute_map (dict): The key is attribute name
 34                            and the value is json key in definition.
 35    """
 36    swagger_types = {
 37        'connected_object_details': 'ConnectedObjectDetails',
 38        'description': 'str',
 39        'format': 'DocGenFormat',
 40        'fully_qualified_path': 'str',
 41        'hidden': 'str',
 42        'label': 'str',
 43        'name': 'str',
 44        'options': 'list[DocGenFormFieldOption]',
 45        'order': 'str',
 46        'predefined_validation': 'str',
 47        'read_only': 'str',
 48        'required': 'str',
 49        'row_values': 'list[DocGenFormFieldRowValue]',
 50        'type': 'str',
 51        'validation': 'DocGenFormFieldValidation',
 52        'value': 'str'
 53    }
 54
 55    attribute_map = {
 56        'connected_object_details': 'connectedObjectDetails',
 57        'description': 'description',
 58        'format': 'format',
 59        'fully_qualified_path': 'fullyQualifiedPath',
 60        'hidden': 'hidden',
 61        'label': 'label',
 62        'name': 'name',
 63        'options': 'options',
 64        'order': 'order',
 65        'predefined_validation': 'predefinedValidation',
 66        'read_only': 'readOnly',
 67        'required': 'required',
 68        'row_values': 'rowValues',
 69        'type': 'type',
 70        'validation': 'validation',
 71        'value': 'value'
 72    }
 73
 74    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 75        """DocGenFormField - a model defined in Swagger"""  # noqa: E501
 76        if _configuration is None:
 77            _configuration = Configuration()
 78        self._configuration = _configuration
 79
 80        self._connected_object_details = None
 81        self._description = None
 82        self._format = None
 83        self._fully_qualified_path = None
 84        self._hidden = None
 85        self._label = None
 86        self._name = None
 87        self._options = None
 88        self._order = None
 89        self._predefined_validation = None
 90        self._read_only = None
 91        self._required = None
 92        self._row_values = None
 93        self._type = None
 94        self._validation = None
 95        self._value = None
 96        self.discriminator = None
 97
 98        setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None))
 99        setattr(self, "_{}".format('description'), kwargs.get('description', None))
100        setattr(self, "_{}".format('format'), kwargs.get('format', None))
101        setattr(self, "_{}".format('fully_qualified_path'), kwargs.get('fully_qualified_path', None))
102        setattr(self, "_{}".format('hidden'), kwargs.get('hidden', None))
103        setattr(self, "_{}".format('label'), kwargs.get('label', None))
104        setattr(self, "_{}".format('name'), kwargs.get('name', None))
105        setattr(self, "_{}".format('options'), kwargs.get('options', None))
106        setattr(self, "_{}".format('order'), kwargs.get('order', None))
107        setattr(self, "_{}".format('predefined_validation'), kwargs.get('predefined_validation', None))
108        setattr(self, "_{}".format('read_only'), kwargs.get('read_only', None))
109        setattr(self, "_{}".format('required'), kwargs.get('required', None))
110        setattr(self, "_{}".format('row_values'), kwargs.get('row_values', None))
111        setattr(self, "_{}".format('type'), kwargs.get('type', None))
112        setattr(self, "_{}".format('validation'), kwargs.get('validation', None))
113        setattr(self, "_{}".format('value'), kwargs.get('value', None))
114
115    @property
116    def connected_object_details(self):
117        """Gets the connected_object_details of this DocGenFormField.  # noqa: E501
118
119          # noqa: E501
120
121        :return: The connected_object_details of this DocGenFormField.  # noqa: E501
122        :rtype: ConnectedObjectDetails
123        """
124        return self._connected_object_details
125
126    @connected_object_details.setter
127    def connected_object_details(self, connected_object_details):
128        """Sets the connected_object_details of this DocGenFormField.
129
130          # noqa: E501
131
132        :param connected_object_details: The connected_object_details of this DocGenFormField.  # noqa: E501
133        :type: ConnectedObjectDetails
134        """
135
136        self._connected_object_details = connected_object_details
137
138    @property
139    def description(self):
140        """Gets the description of this DocGenFormField.  # noqa: E501
141
142          # noqa: E501
143
144        :return: The description of this DocGenFormField.  # noqa: E501
145        :rtype: str
146        """
147        return self._description
148
149    @description.setter
150    def description(self, description):
151        """Sets the description of this DocGenFormField.
152
153          # noqa: E501
154
155        :param description: The description of this DocGenFormField.  # noqa: E501
156        :type: str
157        """
158
159        self._description = description
160
161    @property
162    def format(self):
163        """Gets the format of this DocGenFormField.  # noqa: E501
164
165          # noqa: E501
166
167        :return: The format of this DocGenFormField.  # noqa: E501
168        :rtype: DocGenFormat
169        """
170        return self._format
171
172    @format.setter
173    def format(self, format):
174        """Sets the format of this DocGenFormField.
175
176          # noqa: E501
177
178        :param format: The format of this DocGenFormField.  # noqa: E501
179        :type: DocGenFormat
180        """
181
182        self._format = format
183
184    @property
185    def fully_qualified_path(self):
186        """Gets the fully_qualified_path of this DocGenFormField.  # noqa: E501
187
188          # noqa: E501
189
190        :return: The fully_qualified_path of this DocGenFormField.  # noqa: E501
191        :rtype: str
192        """
193        return self._fully_qualified_path
194
195    @fully_qualified_path.setter
196    def fully_qualified_path(self, fully_qualified_path):
197        """Sets the fully_qualified_path of this DocGenFormField.
198
199          # noqa: E501
200
201        :param fully_qualified_path: The fully_qualified_path of this DocGenFormField.  # noqa: E501
202        :type: str
203        """
204
205        self._fully_qualified_path = fully_qualified_path
206
207    @property
208    def hidden(self):
209        """Gets the hidden of this DocGenFormField.  # noqa: E501
210
211          # noqa: E501
212
213        :return: The hidden of this DocGenFormField.  # noqa: E501
214        :rtype: str
215        """
216        return self._hidden
217
218    @hidden.setter
219    def hidden(self, hidden):
220        """Sets the hidden of this DocGenFormField.
221
222          # noqa: E501
223
224        :param hidden: The hidden of this DocGenFormField.  # noqa: E501
225        :type: str
226        """
227
228        self._hidden = hidden
229
230    @property
231    def label(self):
232        """Gets the label of this DocGenFormField.  # noqa: E501
233
234          # noqa: E501
235
236        :return: The label of this DocGenFormField.  # noqa: E501
237        :rtype: str
238        """
239        return self._label
240
241    @label.setter
242    def label(self, label):
243        """Sets the label of this DocGenFormField.
244
245          # noqa: E501
246
247        :param label: The label of this DocGenFormField.  # noqa: E501
248        :type: str
249        """
250
251        self._label = label
252
253    @property
254    def name(self):
255        """Gets the name of this DocGenFormField.  # noqa: E501
256
257          # noqa: E501
258
259        :return: The name of this DocGenFormField.  # noqa: E501
260        :rtype: str
261        """
262        return self._name
263
264    @name.setter
265    def name(self, name):
266        """Sets the name of this DocGenFormField.
267
268          # noqa: E501
269
270        :param name: The name of this DocGenFormField.  # noqa: E501
271        :type: str
272        """
273
274        self._name = name
275
276    @property
277    def options(self):
278        """Gets the options of this DocGenFormField.  # noqa: E501
279
280          # noqa: E501
281
282        :return: The options of this DocGenFormField.  # noqa: E501
283        :rtype: list[DocGenFormFieldOption]
284        """
285        return self._options
286
287    @options.setter
288    def options(self, options):
289        """Sets the options of this DocGenFormField.
290
291          # noqa: E501
292
293        :param options: The options of this DocGenFormField.  # noqa: E501
294        :type: list[DocGenFormFieldOption]
295        """
296
297        self._options = options
298
299    @property
300    def order(self):
301        """Gets the order of this DocGenFormField.  # noqa: E501
302
303          # noqa: E501
304
305        :return: The order of this DocGenFormField.  # noqa: E501
306        :rtype: str
307        """
308        return self._order
309
310    @order.setter
311    def order(self, order):
312        """Sets the order of this DocGenFormField.
313
314          # noqa: E501
315
316        :param order: The order of this DocGenFormField.  # noqa: E501
317        :type: str
318        """
319
320        self._order = order
321
322    @property
323    def predefined_validation(self):
324        """Gets the predefined_validation of this DocGenFormField.  # noqa: E501
325
326          # noqa: E501
327
328        :return: The predefined_validation of this DocGenFormField.  # noqa: E501
329        :rtype: str
330        """
331        return self._predefined_validation
332
333    @predefined_validation.setter
334    def predefined_validation(self, predefined_validation):
335        """Sets the predefined_validation of this DocGenFormField.
336
337          # noqa: E501
338
339        :param predefined_validation: The predefined_validation of this DocGenFormField.  # noqa: E501
340        :type: str
341        """
342
343        self._predefined_validation = predefined_validation
344
345    @property
346    def read_only(self):
347        """Gets the read_only of this DocGenFormField.  # noqa: E501
348
349          # noqa: E501
350
351        :return: The read_only of this DocGenFormField.  # noqa: E501
352        :rtype: str
353        """
354        return self._read_only
355
356    @read_only.setter
357    def read_only(self, read_only):
358        """Sets the read_only of this DocGenFormField.
359
360          # noqa: E501
361
362        :param read_only: The read_only of this DocGenFormField.  # noqa: E501
363        :type: str
364        """
365
366        self._read_only = read_only
367
368    @property
369    def required(self):
370        """Gets the required of this DocGenFormField.  # noqa: E501
371
372        When set to **true**, the signer is required to fill out this tab  # noqa: E501
373
374        :return: The required of this DocGenFormField.  # noqa: E501
375        :rtype: str
376        """
377        return self._required
378
379    @required.setter
380    def required(self, required):
381        """Sets the required of this DocGenFormField.
382
383        When set to **true**, the signer is required to fill out this tab  # noqa: E501
384
385        :param required: The required of this DocGenFormField.  # noqa: E501
386        :type: str
387        """
388
389        self._required = required
390
391    @property
392    def row_values(self):
393        """Gets the row_values of this DocGenFormField.  # noqa: E501
394
395          # noqa: E501
396
397        :return: The row_values of this DocGenFormField.  # noqa: E501
398        :rtype: list[DocGenFormFieldRowValue]
399        """
400        return self._row_values
401
402    @row_values.setter
403    def row_values(self, row_values):
404        """Sets the row_values of this DocGenFormField.
405
406          # noqa: E501
407
408        :param row_values: The row_values of this DocGenFormField.  # noqa: E501
409        :type: list[DocGenFormFieldRowValue]
410        """
411
412        self._row_values = row_values
413
414    @property
415    def type(self):
416        """Gets the type of this DocGenFormField.  # noqa: E501
417
418          # noqa: E501
419
420        :return: The type of this DocGenFormField.  # noqa: E501
421        :rtype: str
422        """
423        return self._type
424
425    @type.setter
426    def type(self, type):
427        """Sets the type of this DocGenFormField.
428
429          # noqa: E501
430
431        :param type: The type of this DocGenFormField.  # noqa: E501
432        :type: str
433        """
434
435        self._type = type
436
437    @property
438    def validation(self):
439        """Gets the validation of this DocGenFormField.  # noqa: E501
440
441          # noqa: E501
442
443        :return: The validation of this DocGenFormField.  # noqa: E501
444        :rtype: DocGenFormFieldValidation
445        """
446        return self._validation
447
448    @validation.setter
449    def validation(self, validation):
450        """Sets the validation of this DocGenFormField.
451
452          # noqa: E501
453
454        :param validation: The validation of this DocGenFormField.  # noqa: E501
455        :type: DocGenFormFieldValidation
456        """
457
458        self._validation = validation
459
460    @property
461    def value(self):
462        """Gets the value of this DocGenFormField.  # noqa: E501
463
464        Specifies the value of the tab.   # noqa: E501
465
466        :return: The value of this DocGenFormField.  # noqa: E501
467        :rtype: str
468        """
469        return self._value
470
471    @value.setter
472    def value(self, value):
473        """Sets the value of this DocGenFormField.
474
475        Specifies the value of the tab.   # noqa: E501
476
477        :param value: The value of this DocGenFormField.  # noqa: E501
478        :type: str
479        """
480
481        self._value = value
482
483    def to_dict(self):
484        """Returns the model properties as a dict"""
485        result = {}
486
487        for attr, _ in six.iteritems(self.swagger_types):
488            value = getattr(self, attr)
489            if isinstance(value, list):
490                result[attr] = list(map(
491                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
492                    value
493                ))
494            elif hasattr(value, "to_dict"):
495                result[attr] = value.to_dict()
496            elif isinstance(value, dict):
497                result[attr] = dict(map(
498                    lambda item: (item[0], item[1].to_dict())
499                    if hasattr(item[1], "to_dict") else item,
500                    value.items()
501                ))
502            else:
503                result[attr] = value
504        if issubclass(DocGenFormField, dict):
505            for key, value in self.items():
506                result[key] = value
507
508        return result
509
510    def to_str(self):
511        """Returns the string representation of the model"""
512        return pprint.pformat(self.to_dict())
513
514    def __repr__(self):
515        """For `print` and `pprint`"""
516        return self.to_str()
517
518    def __eq__(self, other):
519        """Returns true if both objects are equal"""
520        if not isinstance(other, DocGenFormField):
521            return False
522
523        return self.to_dict() == other.to_dict()
524
525    def __ne__(self, other):
526        """Returns true if both objects are not equal"""
527        if not isinstance(other, DocGenFormField):
528            return True
529
530        return self.to_dict() != other.to_dict()

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

DocGenFormField(_configuration=None, **kwargs)
 74    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 75        """DocGenFormField - a model defined in Swagger"""  # noqa: E501
 76        if _configuration is None:
 77            _configuration = Configuration()
 78        self._configuration = _configuration
 79
 80        self._connected_object_details = None
 81        self._description = None
 82        self._format = None
 83        self._fully_qualified_path = None
 84        self._hidden = None
 85        self._label = None
 86        self._name = None
 87        self._options = None
 88        self._order = None
 89        self._predefined_validation = None
 90        self._read_only = None
 91        self._required = None
 92        self._row_values = None
 93        self._type = None
 94        self._validation = None
 95        self._value = None
 96        self.discriminator = None
 97
 98        setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None))
 99        setattr(self, "_{}".format('description'), kwargs.get('description', None))
100        setattr(self, "_{}".format('format'), kwargs.get('format', None))
101        setattr(self, "_{}".format('fully_qualified_path'), kwargs.get('fully_qualified_path', None))
102        setattr(self, "_{}".format('hidden'), kwargs.get('hidden', None))
103        setattr(self, "_{}".format('label'), kwargs.get('label', None))
104        setattr(self, "_{}".format('name'), kwargs.get('name', None))
105        setattr(self, "_{}".format('options'), kwargs.get('options', None))
106        setattr(self, "_{}".format('order'), kwargs.get('order', None))
107        setattr(self, "_{}".format('predefined_validation'), kwargs.get('predefined_validation', None))
108        setattr(self, "_{}".format('read_only'), kwargs.get('read_only', None))
109        setattr(self, "_{}".format('required'), kwargs.get('required', None))
110        setattr(self, "_{}".format('row_values'), kwargs.get('row_values', None))
111        setattr(self, "_{}".format('type'), kwargs.get('type', None))
112        setattr(self, "_{}".format('validation'), kwargs.get('validation', None))
113        setattr(self, "_{}".format('value'), kwargs.get('value', None))

DocGenFormField - a model defined in Swagger

swagger_types = {'connected_object_details': 'ConnectedObjectDetails', 'description': 'str', 'format': 'DocGenFormat', 'fully_qualified_path': 'str', 'hidden': 'str', 'label': 'str', 'name': 'str', 'options': 'list[DocGenFormFieldOption]', 'order': 'str', 'predefined_validation': 'str', 'read_only': 'str', 'required': 'str', 'row_values': 'list[DocGenFormFieldRowValue]', 'type': 'str', 'validation': 'DocGenFormFieldValidation', 'value': 'str'}
attribute_map = {'connected_object_details': 'connectedObjectDetails', 'description': 'description', 'format': 'format', 'fully_qualified_path': 'fullyQualifiedPath', 'hidden': 'hidden', 'label': 'label', 'name': 'name', 'options': 'options', 'order': 'order', 'predefined_validation': 'predefinedValidation', 'read_only': 'readOnly', 'required': 'required', 'row_values': 'rowValues', 'type': 'type', 'validation': 'validation', 'value': 'value'}
connected_object_details

Gets the connected_object_details of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The connected_object_details of this DocGenFormField. # noqa: E501

description

Gets the description of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The description of this DocGenFormField. # noqa: E501

format

Gets the format of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The format of this DocGenFormField. # noqa: E501

fully_qualified_path

Gets the fully_qualified_path of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The fully_qualified_path of this DocGenFormField. # noqa: E501

hidden

Gets the hidden of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The hidden of this DocGenFormField. # noqa: E501

label

Gets the label of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The label of this DocGenFormField. # noqa: E501

name

Gets the name of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The name of this DocGenFormField. # noqa: E501

options

Gets the options of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The options of this DocGenFormField. # noqa: E501

order

Gets the order of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The order of this DocGenFormField. # noqa: E501

predefined_validation

Gets the predefined_validation of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The predefined_validation of this DocGenFormField. # noqa: E501

read_only

Gets the read_only of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The read_only of this DocGenFormField. # noqa: E501

required

Gets the required of this DocGenFormField. # noqa: E501

When set to true, the signer is required to fill out this tab # noqa: E501

Returns

The required of this DocGenFormField. # noqa: E501

row_values

Gets the row_values of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The row_values of this DocGenFormField. # noqa: E501

type

Gets the type of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The type of this DocGenFormField. # noqa: E501

validation

Gets the validation of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The validation of this DocGenFormField. # noqa: E501

value

Gets the value of this DocGenFormField. # noqa: E501

Specifies the value of the tab. # noqa: E501

Returns

The value of this DocGenFormField. # noqa: E501

def to_dict(self)
483    def to_dict(self):
484        """Returns the model properties as a dict"""
485        result = {}
486
487        for attr, _ in six.iteritems(self.swagger_types):
488            value = getattr(self, attr)
489            if isinstance(value, list):
490                result[attr] = list(map(
491                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
492                    value
493                ))
494            elif hasattr(value, "to_dict"):
495                result[attr] = value.to_dict()
496            elif isinstance(value, dict):
497                result[attr] = dict(map(
498                    lambda item: (item[0], item[1].to_dict())
499                    if hasattr(item[1], "to_dict") else item,
500                    value.items()
501                ))
502            else:
503                result[attr] = value
504        if issubclass(DocGenFormField, dict):
505            for key, value in self.items():
506                result[key] = value
507
508        return result

Returns the model properties as a dict

def to_str(self)
510    def to_str(self):
511        """Returns the string representation of the model"""
512        return pprint.pformat(self.to_dict())

Returns the string representation of the model