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