docusign_esign.models.lock_request

  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 LockRequest(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        'lock_duration_in_seconds': 'str',
 37        'locked_by_app': 'str',
 38        'lock_type': 'str',
 39        'template_password': 'str',
 40        'use_scratch_pad': 'str'
 41    }
 42
 43    attribute_map = {
 44        'lock_duration_in_seconds': 'lockDurationInSeconds',
 45        'locked_by_app': 'lockedByApp',
 46        'lock_type': 'lockType',
 47        'template_password': 'templatePassword',
 48        'use_scratch_pad': 'useScratchPad'
 49    }
 50
 51    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 52        """LockRequest - a model defined in Swagger"""  # noqa: E501
 53        if _configuration is None:
 54            _configuration = Configuration()
 55        self._configuration = _configuration
 56
 57        self._lock_duration_in_seconds = None
 58        self._locked_by_app = None
 59        self._lock_type = None
 60        self._template_password = None
 61        self._use_scratch_pad = None
 62        self.discriminator = None
 63
 64        setattr(self, "_{}".format('lock_duration_in_seconds'), kwargs.get('lock_duration_in_seconds', None))
 65        setattr(self, "_{}".format('locked_by_app'), kwargs.get('locked_by_app', None))
 66        setattr(self, "_{}".format('lock_type'), kwargs.get('lock_type', None))
 67        setattr(self, "_{}".format('template_password'), kwargs.get('template_password', None))
 68        setattr(self, "_{}".format('use_scratch_pad'), kwargs.get('use_scratch_pad', None))
 69
 70    @property
 71    def lock_duration_in_seconds(self):
 72        """Gets the lock_duration_in_seconds of this LockRequest.  # noqa: E501
 73
 74        The number of seconds to lock the envelope for editing.  Must be greater than 0 seconds.  # noqa: E501
 75
 76        :return: The lock_duration_in_seconds of this LockRequest.  # noqa: E501
 77        :rtype: str
 78        """
 79        return self._lock_duration_in_seconds
 80
 81    @lock_duration_in_seconds.setter
 82    def lock_duration_in_seconds(self, lock_duration_in_seconds):
 83        """Sets the lock_duration_in_seconds of this LockRequest.
 84
 85        The number of seconds to lock the envelope for editing.  Must be greater than 0 seconds.  # noqa: E501
 86
 87        :param lock_duration_in_seconds: The lock_duration_in_seconds of this LockRequest.  # noqa: E501
 88        :type: str
 89        """
 90
 91        self._lock_duration_in_seconds = lock_duration_in_seconds
 92
 93    @property
 94    def locked_by_app(self):
 95        """Gets the locked_by_app of this LockRequest.  # noqa: E501
 96
 97        A friendly name of the application used to lock the envelope.  Will be used in error messages to the user when lock conflicts occur.  # noqa: E501
 98
 99        :return: The locked_by_app of this LockRequest.  # noqa: E501
100        :rtype: str
101        """
102        return self._locked_by_app
103
104    @locked_by_app.setter
105    def locked_by_app(self, locked_by_app):
106        """Sets the locked_by_app of this LockRequest.
107
108        A friendly name of the application used to lock the envelope.  Will be used in error messages to the user when lock conflicts occur.  # noqa: E501
109
110        :param locked_by_app: The locked_by_app of this LockRequest.  # noqa: E501
111        :type: str
112        """
113
114        self._locked_by_app = locked_by_app
115
116    @property
117    def lock_type(self):
118        """Gets the lock_type of this LockRequest.  # noqa: E501
119
120        The type of envelope lock.  Currently \"edit\" is the only supported type.  # noqa: E501
121
122        :return: The lock_type of this LockRequest.  # noqa: E501
123        :rtype: str
124        """
125        return self._lock_type
126
127    @lock_type.setter
128    def lock_type(self, lock_type):
129        """Sets the lock_type of this LockRequest.
130
131        The type of envelope lock.  Currently \"edit\" is the only supported type.  # noqa: E501
132
133        :param lock_type: The lock_type of this LockRequest.  # noqa: E501
134        :type: str
135        """
136
137        self._lock_type = lock_type
138
139    @property
140    def template_password(self):
141        """Gets the template_password of this LockRequest.  # noqa: E501
142
143          # noqa: E501
144
145        :return: The template_password of this LockRequest.  # noqa: E501
146        :rtype: str
147        """
148        return self._template_password
149
150    @template_password.setter
151    def template_password(self, template_password):
152        """Sets the template_password of this LockRequest.
153
154          # noqa: E501
155
156        :param template_password: The template_password of this LockRequest.  # noqa: E501
157        :type: str
158        """
159
160        self._template_password = template_password
161
162    @property
163    def use_scratch_pad(self):
164        """Gets the use_scratch_pad of this LockRequest.  # noqa: E501
165
166        Reserved for future use.  Indicates whether a scratchpad is used for editing information.    # noqa: E501
167
168        :return: The use_scratch_pad of this LockRequest.  # noqa: E501
169        :rtype: str
170        """
171        return self._use_scratch_pad
172
173    @use_scratch_pad.setter
174    def use_scratch_pad(self, use_scratch_pad):
175        """Sets the use_scratch_pad of this LockRequest.
176
177        Reserved for future use.  Indicates whether a scratchpad is used for editing information.    # noqa: E501
178
179        :param use_scratch_pad: The use_scratch_pad of this LockRequest.  # noqa: E501
180        :type: str
181        """
182
183        self._use_scratch_pad = use_scratch_pad
184
185    def to_dict(self):
186        """Returns the model properties as a dict"""
187        result = {}
188
189        for attr, _ in six.iteritems(self.swagger_types):
190            value = getattr(self, attr)
191            if isinstance(value, list):
192                result[attr] = list(map(
193                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
194                    value
195                ))
196            elif hasattr(value, "to_dict"):
197                result[attr] = value.to_dict()
198            elif isinstance(value, dict):
199                result[attr] = dict(map(
200                    lambda item: (item[0], item[1].to_dict())
201                    if hasattr(item[1], "to_dict") else item,
202                    value.items()
203                ))
204            else:
205                result[attr] = value
206        if issubclass(LockRequest, dict):
207            for key, value in self.items():
208                result[key] = value
209
210        return result
211
212    def to_str(self):
213        """Returns the string representation of the model"""
214        return pprint.pformat(self.to_dict())
215
216    def __repr__(self):
217        """For `print` and `pprint`"""
218        return self.to_str()
219
220    def __eq__(self, other):
221        """Returns true if both objects are equal"""
222        if not isinstance(other, LockRequest):
223            return False
224
225        return self.to_dict() == other.to_dict()
226
227    def __ne__(self, other):
228        """Returns true if both objects are not equal"""
229        if not isinstance(other, LockRequest):
230            return True
231
232        return self.to_dict() != other.to_dict()