docusign_esign.models.list_item

  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 ListItem(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        'selected': 'str',
 37        'selected_metadata': 'PropertyMetadata',
 38        'text': 'str',
 39        'text_metadata': 'PropertyMetadata',
 40        'value': 'str',
 41        'value_metadata': 'PropertyMetadata'
 42    }
 43
 44    attribute_map = {
 45        'selected': 'selected',
 46        'selected_metadata': 'selectedMetadata',
 47        'text': 'text',
 48        'text_metadata': 'textMetadata',
 49        'value': 'value',
 50        'value_metadata': 'valueMetadata'
 51    }
 52
 53    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 54        """ListItem - a model defined in Swagger"""  # noqa: E501
 55        if _configuration is None:
 56            _configuration = Configuration()
 57        self._configuration = _configuration
 58
 59        self._selected = None
 60        self._selected_metadata = None
 61        self._text = None
 62        self._text_metadata = None
 63        self._value = None
 64        self._value_metadata = None
 65        self.discriminator = None
 66
 67        setattr(self, "_{}".format('selected'), kwargs.get('selected', None))
 68        setattr(self, "_{}".format('selected_metadata'), kwargs.get('selected_metadata', None))
 69        setattr(self, "_{}".format('text'), kwargs.get('text', None))
 70        setattr(self, "_{}".format('text_metadata'), kwargs.get('text_metadata', None))
 71        setattr(self, "_{}".format('value'), kwargs.get('value', None))
 72        setattr(self, "_{}".format('value_metadata'), kwargs.get('value_metadata', None))
 73
 74    @property
 75    def selected(self):
 76        """Gets the selected of this ListItem.  # noqa: E501
 77
 78        When set to **true**, indicates that this item is the default selection shown to a signer.   Only one selection can be set as the default.  # noqa: E501
 79
 80        :return: The selected of this ListItem.  # noqa: E501
 81        :rtype: str
 82        """
 83        return self._selected
 84
 85    @selected.setter
 86    def selected(self, selected):
 87        """Sets the selected of this ListItem.
 88
 89        When set to **true**, indicates that this item is the default selection shown to a signer.   Only one selection can be set as the default.  # noqa: E501
 90
 91        :param selected: The selected of this ListItem.  # noqa: E501
 92        :type: str
 93        """
 94
 95        self._selected = selected
 96
 97    @property
 98    def selected_metadata(self):
 99        """Gets the selected_metadata of this ListItem.  # noqa: E501
100
101        Metadata that indicates whether the `selected` property is editable.  # noqa: E501
102
103        :return: The selected_metadata of this ListItem.  # noqa: E501
104        :rtype: PropertyMetadata
105        """
106        return self._selected_metadata
107
108    @selected_metadata.setter
109    def selected_metadata(self, selected_metadata):
110        """Sets the selected_metadata of this ListItem.
111
112        Metadata that indicates whether the `selected` property is editable.  # noqa: E501
113
114        :param selected_metadata: The selected_metadata of this ListItem.  # noqa: E501
115        :type: PropertyMetadata
116        """
117
118        self._selected_metadata = selected_metadata
119
120    @property
121    def text(self):
122        """Gets the text of this ListItem.  # noqa: E501
123
124        Specifies the text that is shown in the dropdown list.   # noqa: E501
125
126        :return: The text of this ListItem.  # noqa: E501
127        :rtype: str
128        """
129        return self._text
130
131    @text.setter
132    def text(self, text):
133        """Sets the text of this ListItem.
134
135        Specifies the text that is shown in the dropdown list.   # noqa: E501
136
137        :param text: The text of this ListItem.  # noqa: E501
138        :type: str
139        """
140
141        self._text = text
142
143    @property
144    def text_metadata(self):
145        """Gets the text_metadata of this ListItem.  # noqa: E501
146
147          # noqa: E501
148
149        :return: The text_metadata of this ListItem.  # noqa: E501
150        :rtype: PropertyMetadata
151        """
152        return self._text_metadata
153
154    @text_metadata.setter
155    def text_metadata(self, text_metadata):
156        """Sets the text_metadata of this ListItem.
157
158          # noqa: E501
159
160        :param text_metadata: The text_metadata of this ListItem.  # noqa: E501
161        :type: PropertyMetadata
162        """
163
164        self._text_metadata = text_metadata
165
166    @property
167    def value(self):
168        """Gets the value of this ListItem.  # noqa: E501
169
170        Specifies the value that is used when the list item is selected.  # noqa: E501
171
172        :return: The value of this ListItem.  # noqa: E501
173        :rtype: str
174        """
175        return self._value
176
177    @value.setter
178    def value(self, value):
179        """Sets the value of this ListItem.
180
181        Specifies the value that is used when the list item is selected.  # noqa: E501
182
183        :param value: The value of this ListItem.  # noqa: E501
184        :type: str
185        """
186
187        self._value = value
188
189    @property
190    def value_metadata(self):
191        """Gets the value_metadata of this ListItem.  # noqa: E501
192
193        Metadata that indicates whether the `value` property is editable.  # noqa: E501
194
195        :return: The value_metadata of this ListItem.  # noqa: E501
196        :rtype: PropertyMetadata
197        """
198        return self._value_metadata
199
200    @value_metadata.setter
201    def value_metadata(self, value_metadata):
202        """Sets the value_metadata of this ListItem.
203
204        Metadata that indicates whether the `value` property is editable.  # noqa: E501
205
206        :param value_metadata: The value_metadata of this ListItem.  # noqa: E501
207        :type: PropertyMetadata
208        """
209
210        self._value_metadata = value_metadata
211
212    def to_dict(self):
213        """Returns the model properties as a dict"""
214        result = {}
215
216        for attr, _ in six.iteritems(self.swagger_types):
217            value = getattr(self, attr)
218            if isinstance(value, list):
219                result[attr] = list(map(
220                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
221                    value
222                ))
223            elif hasattr(value, "to_dict"):
224                result[attr] = value.to_dict()
225            elif isinstance(value, dict):
226                result[attr] = dict(map(
227                    lambda item: (item[0], item[1].to_dict())
228                    if hasattr(item[1], "to_dict") else item,
229                    value.items()
230                ))
231            else:
232                result[attr] = value
233        if issubclass(ListItem, dict):
234            for key, value in self.items():
235                result[key] = value
236
237        return result
238
239    def to_str(self):
240        """Returns the string representation of the model"""
241        return pprint.pformat(self.to_dict())
242
243    def __repr__(self):
244        """For `print` and `pprint`"""
245        return self.to_str()
246
247    def __eq__(self, other):
248        """Returns true if both objects are equal"""
249        if not isinstance(other, ListItem):
250            return False
251
252        return self.to_dict() == other.to_dict()
253
254    def __ne__(self, other):
255        """Returns true if both objects are not equal"""
256        if not isinstance(other, ListItem):
257            return True
258
259        return self.to_dict() != other.to_dict()