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

DocGenFormField - a model defined in Swagger

swagger_types = {'connected_object_details': 'ConnectedObjectDetails', 'default_value': 'str', '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', 'default_value': 'defaultValue', '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

default_value

Gets the default_value of this DocGenFormField. # noqa: E501

# noqa: E501

Returns

The default_value 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)
510    def to_dict(self):
511        """Returns the model properties as a dict"""
512        result = {}
513
514        for attr, _ in six.iteritems(self.swagger_types):
515            value = getattr(self, attr)
516            if isinstance(value, list):
517                result[attr] = list(map(
518                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
519                    value
520                ))
521            elif hasattr(value, "to_dict"):
522                result[attr] = value.to_dict()
523            elif isinstance(value, dict):
524                result[attr] = dict(map(
525                    lambda item: (item[0], item[1].to_dict())
526                    if hasattr(item[1], "to_dict") else item,
527                    value.items()
528                ))
529            else:
530                result[attr] = value
531        if issubclass(DocGenFormField, dict):
532            for key, value in self.items():
533                result[key] = value
534
535        return result

Returns the model properties as a dict

def to_str(self)
537    def to_str(self):
538        """Returns the string representation of the model"""
539        return pprint.pformat(self.to_dict())

Returns the string representation of the model