docusign_esign.models.lock_information

  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 LockInformation(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        'error_details': 'ErrorDetails',
 37        'lock_duration_in_seconds': 'str',
 38        'locked_by_app': 'str',
 39        'locked_by_user': 'UserInfo',
 40        'locked_until_date_time': 'str',
 41        'lock_token': 'str',
 42        'lock_type': 'str',
 43        'use_scratch_pad': 'str'
 44    }
 45
 46    attribute_map = {
 47        'error_details': 'errorDetails',
 48        'lock_duration_in_seconds': 'lockDurationInSeconds',
 49        'locked_by_app': 'lockedByApp',
 50        'locked_by_user': 'lockedByUser',
 51        'locked_until_date_time': 'lockedUntilDateTime',
 52        'lock_token': 'lockToken',
 53        'lock_type': 'lockType',
 54        'use_scratch_pad': 'useScratchPad'
 55    }
 56
 57    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 58        """LockInformation - a model defined in Swagger"""  # noqa: E501
 59        if _configuration is None:
 60            _configuration = Configuration()
 61        self._configuration = _configuration
 62
 63        self._error_details = None
 64        self._lock_duration_in_seconds = None
 65        self._locked_by_app = None
 66        self._locked_by_user = None
 67        self._locked_until_date_time = None
 68        self._lock_token = None
 69        self._lock_type = None
 70        self._use_scratch_pad = None
 71        self.discriminator = None
 72
 73        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
 74        setattr(self, "_{}".format('lock_duration_in_seconds'), kwargs.get('lock_duration_in_seconds', None))
 75        setattr(self, "_{}".format('locked_by_app'), kwargs.get('locked_by_app', None))
 76        setattr(self, "_{}".format('locked_by_user'), kwargs.get('locked_by_user', None))
 77        setattr(self, "_{}".format('locked_until_date_time'), kwargs.get('locked_until_date_time', None))
 78        setattr(self, "_{}".format('lock_token'), kwargs.get('lock_token', None))
 79        setattr(self, "_{}".format('lock_type'), kwargs.get('lock_type', None))
 80        setattr(self, "_{}".format('use_scratch_pad'), kwargs.get('use_scratch_pad', None))
 81
 82    @property
 83    def error_details(self):
 84        """Gets the error_details of this LockInformation.  # noqa: E501
 85
 86        Array or errors.  # noqa: E501
 87
 88        :return: The error_details of this LockInformation.  # noqa: E501
 89        :rtype: ErrorDetails
 90        """
 91        return self._error_details
 92
 93    @error_details.setter
 94    def error_details(self, error_details):
 95        """Sets the error_details of this LockInformation.
 96
 97        Array or errors.  # noqa: E501
 98
 99        :param error_details: The error_details of this LockInformation.  # noqa: E501
100        :type: ErrorDetails
101        """
102
103        self._error_details = error_details
104
105    @property
106    def lock_duration_in_seconds(self):
107        """Gets the lock_duration_in_seconds of this LockInformation.  # noqa: E501
108
109        Sets the time, in seconds, until the lock expires when there is no activity on the envelope.  If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds.  The lock duration can be extended.   # noqa: E501
110
111        :return: The lock_duration_in_seconds of this LockInformation.  # noqa: E501
112        :rtype: str
113        """
114        return self._lock_duration_in_seconds
115
116    @lock_duration_in_seconds.setter
117    def lock_duration_in_seconds(self, lock_duration_in_seconds):
118        """Sets the lock_duration_in_seconds of this LockInformation.
119
120        Sets the time, in seconds, until the lock expires when there is no activity on the envelope.  If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds.  The lock duration can be extended.   # noqa: E501
121
122        :param lock_duration_in_seconds: The lock_duration_in_seconds of this LockInformation.  # noqa: E501
123        :type: str
124        """
125
126        self._lock_duration_in_seconds = lock_duration_in_seconds
127
128    @property
129    def locked_by_app(self):
130        """Gets the locked_by_app of this LockInformation.  # noqa: E501
131
132        Specifies the friendly name of  the application that is locking the envelope.  # noqa: E501
133
134        :return: The locked_by_app of this LockInformation.  # noqa: E501
135        :rtype: str
136        """
137        return self._locked_by_app
138
139    @locked_by_app.setter
140    def locked_by_app(self, locked_by_app):
141        """Sets the locked_by_app of this LockInformation.
142
143        Specifies the friendly name of  the application that is locking the envelope.  # noqa: E501
144
145        :param locked_by_app: The locked_by_app of this LockInformation.  # noqa: E501
146        :type: str
147        """
148
149        self._locked_by_app = locked_by_app
150
151    @property
152    def locked_by_user(self):
153        """Gets the locked_by_user of this LockInformation.  # noqa: E501
154
155        A complex type containing information about the user that has the envelope or template locked.  # noqa: E501
156
157        :return: The locked_by_user of this LockInformation.  # noqa: E501
158        :rtype: UserInfo
159        """
160        return self._locked_by_user
161
162    @locked_by_user.setter
163    def locked_by_user(self, locked_by_user):
164        """Sets the locked_by_user of this LockInformation.
165
166        A complex type containing information about the user that has the envelope or template locked.  # noqa: E501
167
168        :param locked_by_user: The locked_by_user of this LockInformation.  # noqa: E501
169        :type: UserInfo
170        """
171
172        self._locked_by_user = locked_by_user
173
174    @property
175    def locked_until_date_time(self):
176        """Gets the locked_until_date_time of this LockInformation.  # noqa: E501
177
178        The datetime until the envelope lock expires.  # noqa: E501
179
180        :return: The locked_until_date_time of this LockInformation.  # noqa: E501
181        :rtype: str
182        """
183        return self._locked_until_date_time
184
185    @locked_until_date_time.setter
186    def locked_until_date_time(self, locked_until_date_time):
187        """Sets the locked_until_date_time of this LockInformation.
188
189        The datetime until the envelope lock expires.  # noqa: E501
190
191        :param locked_until_date_time: The locked_until_date_time of this LockInformation.  # noqa: E501
192        :type: str
193        """
194
195        self._locked_until_date_time = locked_until_date_time
196
197    @property
198    def lock_token(self):
199        """Gets the lock_token of this LockInformation.  # noqa: E501
200
201        A unique identifier provided to the owner of the envelope lock.   Used to prove ownership of the lock.  # noqa: E501
202
203        :return: The lock_token of this LockInformation.  # noqa: E501
204        :rtype: str
205        """
206        return self._lock_token
207
208    @lock_token.setter
209    def lock_token(self, lock_token):
210        """Sets the lock_token of this LockInformation.
211
212        A unique identifier provided to the owner of the envelope lock.   Used to prove ownership of the lock.  # noqa: E501
213
214        :param lock_token: The lock_token of this LockInformation.  # noqa: E501
215        :type: str
216        """
217
218        self._lock_token = lock_token
219
220    @property
221    def lock_type(self):
222        """Gets the lock_type of this LockInformation.  # noqa: E501
223
224        The type of envelope lock.  Currently \"edit\" is the only supported type.  # noqa: E501
225
226        :return: The lock_type of this LockInformation.  # noqa: E501
227        :rtype: str
228        """
229        return self._lock_type
230
231    @lock_type.setter
232    def lock_type(self, lock_type):
233        """Sets the lock_type of this LockInformation.
234
235        The type of envelope lock.  Currently \"edit\" is the only supported type.  # noqa: E501
236
237        :param lock_type: The lock_type of this LockInformation.  # noqa: E501
238        :type: str
239        """
240
241        self._lock_type = lock_type
242
243    @property
244    def use_scratch_pad(self):
245        """Gets the use_scratch_pad of this LockInformation.  # noqa: E501
246
247        Reserved for future use.  Indicates whether a scratchpad is used for editing information.    # noqa: E501
248
249        :return: The use_scratch_pad of this LockInformation.  # noqa: E501
250        :rtype: str
251        """
252        return self._use_scratch_pad
253
254    @use_scratch_pad.setter
255    def use_scratch_pad(self, use_scratch_pad):
256        """Sets the use_scratch_pad of this LockInformation.
257
258        Reserved for future use.  Indicates whether a scratchpad is used for editing information.    # noqa: E501
259
260        :param use_scratch_pad: The use_scratch_pad of this LockInformation.  # noqa: E501
261        :type: str
262        """
263
264        self._use_scratch_pad = use_scratch_pad
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(LockInformation, 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, LockInformation):
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, LockInformation):
311            return True
312
313        return self.to_dict() != other.to_dict()