docusign_esign.models.access_code_format

  1# coding: utf-8
  2
  3"""
  4    DocuSign REST API
  5
  6    The DocuSign 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 AccessCodeFormat(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        'format_required': 'str',
 37        'format_required_metadata': 'SettingsMetadata',
 38        'letter_required': 'str',
 39        'letter_required_metadata': 'SettingsMetadata',
 40        'minimum_length': 'str',
 41        'minimum_length_metadata': 'SettingsMetadata',
 42        'number_required': 'str',
 43        'number_required_metadata': 'SettingsMetadata',
 44        'special_character_required': 'str',
 45        'special_character_required_metadata': 'SettingsMetadata'
 46    }
 47
 48    attribute_map = {
 49        'format_required': 'formatRequired',
 50        'format_required_metadata': 'formatRequiredMetadata',
 51        'letter_required': 'letterRequired',
 52        'letter_required_metadata': 'letterRequiredMetadata',
 53        'minimum_length': 'minimumLength',
 54        'minimum_length_metadata': 'minimumLengthMetadata',
 55        'number_required': 'numberRequired',
 56        'number_required_metadata': 'numberRequiredMetadata',
 57        'special_character_required': 'specialCharacterRequired',
 58        'special_character_required_metadata': 'specialCharacterRequiredMetadata'
 59    }
 60
 61    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 62        """AccessCodeFormat - a model defined in Swagger"""  # noqa: E501
 63        if _configuration is None:
 64            _configuration = Configuration()
 65        self._configuration = _configuration
 66
 67        self._format_required = None
 68        self._format_required_metadata = None
 69        self._letter_required = None
 70        self._letter_required_metadata = None
 71        self._minimum_length = None
 72        self._minimum_length_metadata = None
 73        self._number_required = None
 74        self._number_required_metadata = None
 75        self._special_character_required = None
 76        self._special_character_required_metadata = None
 77        self.discriminator = None
 78
 79        setattr(self, "_{}".format('format_required'), kwargs.get('format_required', None))
 80        setattr(self, "_{}".format('format_required_metadata'), kwargs.get('format_required_metadata', None))
 81        setattr(self, "_{}".format('letter_required'), kwargs.get('letter_required', None))
 82        setattr(self, "_{}".format('letter_required_metadata'), kwargs.get('letter_required_metadata', None))
 83        setattr(self, "_{}".format('minimum_length'), kwargs.get('minimum_length', None))
 84        setattr(self, "_{}".format('minimum_length_metadata'), kwargs.get('minimum_length_metadata', None))
 85        setattr(self, "_{}".format('number_required'), kwargs.get('number_required', None))
 86        setattr(self, "_{}".format('number_required_metadata'), kwargs.get('number_required_metadata', None))
 87        setattr(self, "_{}".format('special_character_required'), kwargs.get('special_character_required', None))
 88        setattr(self, "_{}".format('special_character_required_metadata'), kwargs.get('special_character_required_metadata', None))
 89
 90    @property
 91    def format_required(self):
 92        """Gets the format_required of this AccessCodeFormat.  # noqa: E501
 93
 94          # noqa: E501
 95
 96        :return: The format_required of this AccessCodeFormat.  # noqa: E501
 97        :rtype: str
 98        """
 99        return self._format_required
100
101    @format_required.setter
102    def format_required(self, format_required):
103        """Sets the format_required of this AccessCodeFormat.
104
105          # noqa: E501
106
107        :param format_required: The format_required of this AccessCodeFormat.  # noqa: E501
108        :type: str
109        """
110
111        self._format_required = format_required
112
113    @property
114    def format_required_metadata(self):
115        """Gets the format_required_metadata of this AccessCodeFormat.  # noqa: E501
116
117        Metadata indicating whether the `formatRequired` property is editable.  # noqa: E501
118
119        :return: The format_required_metadata of this AccessCodeFormat.  # noqa: E501
120        :rtype: SettingsMetadata
121        """
122        return self._format_required_metadata
123
124    @format_required_metadata.setter
125    def format_required_metadata(self, format_required_metadata):
126        """Sets the format_required_metadata of this AccessCodeFormat.
127
128        Metadata indicating whether the `formatRequired` property is editable.  # noqa: E501
129
130        :param format_required_metadata: The format_required_metadata of this AccessCodeFormat.  # noqa: E501
131        :type: SettingsMetadata
132        """
133
134        self._format_required_metadata = format_required_metadata
135
136    @property
137    def letter_required(self):
138        """Gets the letter_required of this AccessCodeFormat.  # noqa: E501
139
140          # noqa: E501
141
142        :return: The letter_required of this AccessCodeFormat.  # noqa: E501
143        :rtype: str
144        """
145        return self._letter_required
146
147    @letter_required.setter
148    def letter_required(self, letter_required):
149        """Sets the letter_required of this AccessCodeFormat.
150
151          # noqa: E501
152
153        :param letter_required: The letter_required of this AccessCodeFormat.  # noqa: E501
154        :type: str
155        """
156
157        self._letter_required = letter_required
158
159    @property
160    def letter_required_metadata(self):
161        """Gets the letter_required_metadata of this AccessCodeFormat.  # noqa: E501
162
163        Metadata indicating whether the `letterRequired` property is editable.  # noqa: E501
164
165        :return: The letter_required_metadata of this AccessCodeFormat.  # noqa: E501
166        :rtype: SettingsMetadata
167        """
168        return self._letter_required_metadata
169
170    @letter_required_metadata.setter
171    def letter_required_metadata(self, letter_required_metadata):
172        """Sets the letter_required_metadata of this AccessCodeFormat.
173
174        Metadata indicating whether the `letterRequired` property is editable.  # noqa: E501
175
176        :param letter_required_metadata: The letter_required_metadata of this AccessCodeFormat.  # noqa: E501
177        :type: SettingsMetadata
178        """
179
180        self._letter_required_metadata = letter_required_metadata
181
182    @property
183    def minimum_length(self):
184        """Gets the minimum_length of this AccessCodeFormat.  # noqa: E501
185
186          # noqa: E501
187
188        :return: The minimum_length of this AccessCodeFormat.  # noqa: E501
189        :rtype: str
190        """
191        return self._minimum_length
192
193    @minimum_length.setter
194    def minimum_length(self, minimum_length):
195        """Sets the minimum_length of this AccessCodeFormat.
196
197          # noqa: E501
198
199        :param minimum_length: The minimum_length of this AccessCodeFormat.  # noqa: E501
200        :type: str
201        """
202
203        self._minimum_length = minimum_length
204
205    @property
206    def minimum_length_metadata(self):
207        """Gets the minimum_length_metadata of this AccessCodeFormat.  # noqa: E501
208
209        Metadata indicating whether the `minimumLength` property is editable.  # noqa: E501
210
211        :return: The minimum_length_metadata of this AccessCodeFormat.  # noqa: E501
212        :rtype: SettingsMetadata
213        """
214        return self._minimum_length_metadata
215
216    @minimum_length_metadata.setter
217    def minimum_length_metadata(self, minimum_length_metadata):
218        """Sets the minimum_length_metadata of this AccessCodeFormat.
219
220        Metadata indicating whether the `minimumLength` property is editable.  # noqa: E501
221
222        :param minimum_length_metadata: The minimum_length_metadata of this AccessCodeFormat.  # noqa: E501
223        :type: SettingsMetadata
224        """
225
226        self._minimum_length_metadata = minimum_length_metadata
227
228    @property
229    def number_required(self):
230        """Gets the number_required of this AccessCodeFormat.  # noqa: E501
231
232          # noqa: E501
233
234        :return: The number_required of this AccessCodeFormat.  # noqa: E501
235        :rtype: str
236        """
237        return self._number_required
238
239    @number_required.setter
240    def number_required(self, number_required):
241        """Sets the number_required of this AccessCodeFormat.
242
243          # noqa: E501
244
245        :param number_required: The number_required of this AccessCodeFormat.  # noqa: E501
246        :type: str
247        """
248
249        self._number_required = number_required
250
251    @property
252    def number_required_metadata(self):
253        """Gets the number_required_metadata of this AccessCodeFormat.  # noqa: E501
254
255        Metadata indicating whether the `numberRequired` property is editable.  # noqa: E501
256
257        :return: The number_required_metadata of this AccessCodeFormat.  # noqa: E501
258        :rtype: SettingsMetadata
259        """
260        return self._number_required_metadata
261
262    @number_required_metadata.setter
263    def number_required_metadata(self, number_required_metadata):
264        """Sets the number_required_metadata of this AccessCodeFormat.
265
266        Metadata indicating whether the `numberRequired` property is editable.  # noqa: E501
267
268        :param number_required_metadata: The number_required_metadata of this AccessCodeFormat.  # noqa: E501
269        :type: SettingsMetadata
270        """
271
272        self._number_required_metadata = number_required_metadata
273
274    @property
275    def special_character_required(self):
276        """Gets the special_character_required of this AccessCodeFormat.  # noqa: E501
277
278          # noqa: E501
279
280        :return: The special_character_required of this AccessCodeFormat.  # noqa: E501
281        :rtype: str
282        """
283        return self._special_character_required
284
285    @special_character_required.setter
286    def special_character_required(self, special_character_required):
287        """Sets the special_character_required of this AccessCodeFormat.
288
289          # noqa: E501
290
291        :param special_character_required: The special_character_required of this AccessCodeFormat.  # noqa: E501
292        :type: str
293        """
294
295        self._special_character_required = special_character_required
296
297    @property
298    def special_character_required_metadata(self):
299        """Gets the special_character_required_metadata of this AccessCodeFormat.  # noqa: E501
300
301        Metadata indicating whether the `specialCharacterRequired` property is editable.  # noqa: E501
302
303        :return: The special_character_required_metadata of this AccessCodeFormat.  # noqa: E501
304        :rtype: SettingsMetadata
305        """
306        return self._special_character_required_metadata
307
308    @special_character_required_metadata.setter
309    def special_character_required_metadata(self, special_character_required_metadata):
310        """Sets the special_character_required_metadata of this AccessCodeFormat.
311
312        Metadata indicating whether the `specialCharacterRequired` property is editable.  # noqa: E501
313
314        :param special_character_required_metadata: The special_character_required_metadata of this AccessCodeFormat.  # noqa: E501
315        :type: SettingsMetadata
316        """
317
318        self._special_character_required_metadata = special_character_required_metadata
319
320    def to_dict(self):
321        """Returns the model properties as a dict"""
322        result = {}
323
324        for attr, _ in six.iteritems(self.swagger_types):
325            value = getattr(self, attr)
326            if isinstance(value, list):
327                result[attr] = list(map(
328                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
329                    value
330                ))
331            elif hasattr(value, "to_dict"):
332                result[attr] = value.to_dict()
333            elif isinstance(value, dict):
334                result[attr] = dict(map(
335                    lambda item: (item[0], item[1].to_dict())
336                    if hasattr(item[1], "to_dict") else item,
337                    value.items()
338                ))
339            else:
340                result[attr] = value
341        if issubclass(AccessCodeFormat, dict):
342            for key, value in self.items():
343                result[key] = value
344
345        return result
346
347    def to_str(self):
348        """Returns the string representation of the model"""
349        return pprint.pformat(self.to_dict())
350
351    def __repr__(self):
352        """For `print` and `pprint`"""
353        return self.to_str()
354
355    def __eq__(self, other):
356        """Returns true if both objects are equal"""
357        if not isinstance(other, AccessCodeFormat):
358            return False
359
360        return self.to_dict() == other.to_dict()
361
362    def __ne__(self, other):
363        """Returns true if both objects are not equal"""
364        if not isinstance(other, AccessCodeFormat):
365            return True
366
367        return self.to_dict() != other.to_dict()