docusign_esign.models.text_custom_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 TextCustomField(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        'configuration_type': 'str',
 37        'error_details': 'ErrorDetails',
 38        'field_id': 'str',
 39        'name': 'str',
 40        'required': 'str',
 41        'show': 'str',
 42        'value': 'str'
 43    }
 44
 45    attribute_map = {
 46        'configuration_type': 'configurationType',
 47        'error_details': 'errorDetails',
 48        'field_id': 'fieldId',
 49        'name': 'name',
 50        'required': 'required',
 51        'show': 'show',
 52        'value': 'value'
 53    }
 54
 55    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 56        """TextCustomField - a model defined in Swagger"""  # noqa: E501
 57        if _configuration is None:
 58            _configuration = Configuration()
 59        self._configuration = _configuration
 60
 61        self._configuration_type = None
 62        self._error_details = None
 63        self._field_id = None
 64        self._name = None
 65        self._required = None
 66        self._show = None
 67        self._value = None
 68        self.discriminator = None
 69
 70        setattr(self, "_{}".format('configuration_type'), kwargs.get('configuration_type', None))
 71        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
 72        setattr(self, "_{}".format('field_id'), kwargs.get('field_id', None))
 73        setattr(self, "_{}".format('name'), kwargs.get('name', None))
 74        setattr(self, "_{}".format('required'), kwargs.get('required', None))
 75        setattr(self, "_{}".format('show'), kwargs.get('show', None))
 76        setattr(self, "_{}".format('value'), kwargs.get('value', None))
 77
 78    @property
 79    def configuration_type(self):
 80        """Gets the configuration_type of this TextCustomField.  # noqa: E501
 81
 82        If merge field's are being used, specifies the type of the merge field. The only  supported value is **salesforce**.  # noqa: E501
 83
 84        :return: The configuration_type of this TextCustomField.  # noqa: E501
 85        :rtype: str
 86        """
 87        return self._configuration_type
 88
 89    @configuration_type.setter
 90    def configuration_type(self, configuration_type):
 91        """Sets the configuration_type of this TextCustomField.
 92
 93        If merge field's are being used, specifies the type of the merge field. The only  supported value is **salesforce**.  # noqa: E501
 94
 95        :param configuration_type: The configuration_type of this TextCustomField.  # noqa: E501
 96        :type: str
 97        """
 98
 99        self._configuration_type = configuration_type
100
101    @property
102    def error_details(self):
103        """Gets the error_details of this TextCustomField.  # noqa: E501
104
105        Array or errors.  # noqa: E501
106
107        :return: The error_details of this TextCustomField.  # noqa: E501
108        :rtype: ErrorDetails
109        """
110        return self._error_details
111
112    @error_details.setter
113    def error_details(self, error_details):
114        """Sets the error_details of this TextCustomField.
115
116        Array or errors.  # noqa: E501
117
118        :param error_details: The error_details of this TextCustomField.  # noqa: E501
119        :type: ErrorDetails
120        """
121
122        self._error_details = error_details
123
124    @property
125    def field_id(self):
126        """Gets the field_id of this TextCustomField.  # noqa: E501
127
128        An ID used to specify a custom field.  # noqa: E501
129
130        :return: The field_id of this TextCustomField.  # noqa: E501
131        :rtype: str
132        """
133        return self._field_id
134
135    @field_id.setter
136    def field_id(self, field_id):
137        """Sets the field_id of this TextCustomField.
138
139        An ID used to specify a custom field.  # noqa: E501
140
141        :param field_id: The field_id of this TextCustomField.  # noqa: E501
142        :type: str
143        """
144
145        self._field_id = field_id
146
147    @property
148    def name(self):
149        """Gets the name of this TextCustomField.  # noqa: E501
150
151        The name of the custom field.  # noqa: E501
152
153        :return: The name of this TextCustomField.  # noqa: E501
154        :rtype: str
155        """
156        return self._name
157
158    @name.setter
159    def name(self, name):
160        """Sets the name of this TextCustomField.
161
162        The name of the custom field.  # noqa: E501
163
164        :param name: The name of this TextCustomField.  # noqa: E501
165        :type: str
166        """
167
168        self._name = name
169
170    @property
171    def required(self):
172        """Gets the required of this TextCustomField.  # noqa: E501
173
174        When set to **true**, the signer is required to fill out this tab  # noqa: E501
175
176        :return: The required of this TextCustomField.  # noqa: E501
177        :rtype: str
178        """
179        return self._required
180
181    @required.setter
182    def required(self, required):
183        """Sets the required of this TextCustomField.
184
185        When set to **true**, the signer is required to fill out this tab  # noqa: E501
186
187        :param required: The required of this TextCustomField.  # noqa: E501
188        :type: str
189        """
190
191        self._required = required
192
193    @property
194    def show(self):
195        """Gets the show of this TextCustomField.  # noqa: E501
196
197        A boolean indicating if the value should be displayed.  # noqa: E501
198
199        :return: The show of this TextCustomField.  # noqa: E501
200        :rtype: str
201        """
202        return self._show
203
204    @show.setter
205    def show(self, show):
206        """Sets the show of this TextCustomField.
207
208        A boolean indicating if the value should be displayed.  # noqa: E501
209
210        :param show: The show of this TextCustomField.  # noqa: E501
211        :type: str
212        """
213
214        self._show = show
215
216    @property
217    def value(self):
218        """Gets the value of this TextCustomField.  # noqa: E501
219
220        The value of the custom field.  # noqa: E501
221
222        :return: The value of this TextCustomField.  # noqa: E501
223        :rtype: str
224        """
225        return self._value
226
227    @value.setter
228    def value(self, value):
229        """Sets the value of this TextCustomField.
230
231        The value of the custom field.  # noqa: E501
232
233        :param value: The value of this TextCustomField.  # noqa: E501
234        :type: str
235        """
236
237        self._value = value
238
239    def to_dict(self):
240        """Returns the model properties as a dict"""
241        result = {}
242
243        for attr, _ in six.iteritems(self.swagger_types):
244            value = getattr(self, attr)
245            if isinstance(value, list):
246                result[attr] = list(map(
247                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
248                    value
249                ))
250            elif hasattr(value, "to_dict"):
251                result[attr] = value.to_dict()
252            elif isinstance(value, dict):
253                result[attr] = dict(map(
254                    lambda item: (item[0], item[1].to_dict())
255                    if hasattr(item[1], "to_dict") else item,
256                    value.items()
257                ))
258            else:
259                result[attr] = value
260        if issubclass(TextCustomField, dict):
261            for key, value in self.items():
262                result[key] = value
263
264        return result
265
266    def to_str(self):
267        """Returns the string representation of the model"""
268        return pprint.pformat(self.to_dict())
269
270    def __repr__(self):
271        """For `print` and `pprint`"""
272        return self.to_str()
273
274    def __eq__(self, other):
275        """Returns true if both objects are equal"""
276        if not isinstance(other, TextCustomField):
277            return False
278
279        return self.to_dict() == other.to_dict()
280
281    def __ne__(self, other):
282        """Returns true if both objects are not equal"""
283        if not isinstance(other, TextCustomField):
284            return True
285
286        return self.to_dict() != other.to_dict()