docusign_esign.models.recipient_preview_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 RecipientPreviewRequest(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        'assertion_id': 'str',
 37        'authentication_instant': 'str',
 38        'authentication_method': 'str',
 39        'client_ur_ls': 'RecipientTokenClientURLs',
 40        'ping_frequency': 'str',
 41        'ping_url': 'str',
 42        'recipient_id': 'str',
 43        'return_url': 'str',
 44        'security_domain': 'str',
 45        'x_frame_options': 'str',
 46        'x_frame_options_allow_from_url': 'str'
 47    }
 48
 49    attribute_map = {
 50        'assertion_id': 'assertionId',
 51        'authentication_instant': 'authenticationInstant',
 52        'authentication_method': 'authenticationMethod',
 53        'client_ur_ls': 'clientURLs',
 54        'ping_frequency': 'pingFrequency',
 55        'ping_url': 'pingUrl',
 56        'recipient_id': 'recipientId',
 57        'return_url': 'returnUrl',
 58        'security_domain': 'securityDomain',
 59        'x_frame_options': 'xFrameOptions',
 60        'x_frame_options_allow_from_url': 'xFrameOptionsAllowFromUrl'
 61    }
 62
 63    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 64        """RecipientPreviewRequest - a model defined in Swagger"""  # noqa: E501
 65        if _configuration is None:
 66            _configuration = Configuration()
 67        self._configuration = _configuration
 68
 69        self._assertion_id = None
 70        self._authentication_instant = None
 71        self._authentication_method = None
 72        self._client_ur_ls = None
 73        self._ping_frequency = None
 74        self._ping_url = None
 75        self._recipient_id = None
 76        self._return_url = None
 77        self._security_domain = None
 78        self._x_frame_options = None
 79        self._x_frame_options_allow_from_url = None
 80        self.discriminator = None
 81
 82        setattr(self, "_{}".format('assertion_id'), kwargs.get('assertion_id', None))
 83        setattr(self, "_{}".format('authentication_instant'), kwargs.get('authentication_instant', None))
 84        setattr(self, "_{}".format('authentication_method'), kwargs.get('authentication_method', None))
 85        setattr(self, "_{}".format('client_ur_ls'), kwargs.get('client_ur_ls', None))
 86        setattr(self, "_{}".format('ping_frequency'), kwargs.get('ping_frequency', None))
 87        setattr(self, "_{}".format('ping_url'), kwargs.get('ping_url', None))
 88        setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None))
 89        setattr(self, "_{}".format('return_url'), kwargs.get('return_url', None))
 90        setattr(self, "_{}".format('security_domain'), kwargs.get('security_domain', None))
 91        setattr(self, "_{}".format('x_frame_options'), kwargs.get('x_frame_options', None))
 92        setattr(self, "_{}".format('x_frame_options_allow_from_url'), kwargs.get('x_frame_options_allow_from_url', None))
 93
 94    @property
 95    def assertion_id(self):
 96        """Gets the assertion_id of this RecipientPreviewRequest.  # noqa: E501
 97
 98          # noqa: E501
 99
100        :return: The assertion_id of this RecipientPreviewRequest.  # noqa: E501
101        :rtype: str
102        """
103        return self._assertion_id
104
105    @assertion_id.setter
106    def assertion_id(self, assertion_id):
107        """Sets the assertion_id of this RecipientPreviewRequest.
108
109          # noqa: E501
110
111        :param assertion_id: The assertion_id of this RecipientPreviewRequest.  # noqa: E501
112        :type: str
113        """
114
115        self._assertion_id = assertion_id
116
117    @property
118    def authentication_instant(self):
119        """Gets the authentication_instant of this RecipientPreviewRequest.  # noqa: E501
120
121          # noqa: E501
122
123        :return: The authentication_instant of this RecipientPreviewRequest.  # noqa: E501
124        :rtype: str
125        """
126        return self._authentication_instant
127
128    @authentication_instant.setter
129    def authentication_instant(self, authentication_instant):
130        """Sets the authentication_instant of this RecipientPreviewRequest.
131
132          # noqa: E501
133
134        :param authentication_instant: The authentication_instant of this RecipientPreviewRequest.  # noqa: E501
135        :type: str
136        """
137
138        self._authentication_instant = authentication_instant
139
140    @property
141    def authentication_method(self):
142        """Gets the authentication_method of this RecipientPreviewRequest.  # noqa: E501
143
144          # noqa: E501
145
146        :return: The authentication_method of this RecipientPreviewRequest.  # noqa: E501
147        :rtype: str
148        """
149        return self._authentication_method
150
151    @authentication_method.setter
152    def authentication_method(self, authentication_method):
153        """Sets the authentication_method of this RecipientPreviewRequest.
154
155          # noqa: E501
156
157        :param authentication_method: The authentication_method of this RecipientPreviewRequest.  # noqa: E501
158        :type: str
159        """
160
161        self._authentication_method = authentication_method
162
163    @property
164    def client_ur_ls(self):
165        """Gets the client_ur_ls of this RecipientPreviewRequest.  # noqa: E501
166
167          # noqa: E501
168
169        :return: The client_ur_ls of this RecipientPreviewRequest.  # noqa: E501
170        :rtype: RecipientTokenClientURLs
171        """
172        return self._client_ur_ls
173
174    @client_ur_ls.setter
175    def client_ur_ls(self, client_ur_ls):
176        """Sets the client_ur_ls of this RecipientPreviewRequest.
177
178          # noqa: E501
179
180        :param client_ur_ls: The client_ur_ls of this RecipientPreviewRequest.  # noqa: E501
181        :type: RecipientTokenClientURLs
182        """
183
184        self._client_ur_ls = client_ur_ls
185
186    @property
187    def ping_frequency(self):
188        """Gets the ping_frequency of this RecipientPreviewRequest.  # noqa: E501
189
190          # noqa: E501
191
192        :return: The ping_frequency of this RecipientPreviewRequest.  # noqa: E501
193        :rtype: str
194        """
195        return self._ping_frequency
196
197    @ping_frequency.setter
198    def ping_frequency(self, ping_frequency):
199        """Sets the ping_frequency of this RecipientPreviewRequest.
200
201          # noqa: E501
202
203        :param ping_frequency: The ping_frequency of this RecipientPreviewRequest.  # noqa: E501
204        :type: str
205        """
206
207        self._ping_frequency = ping_frequency
208
209    @property
210    def ping_url(self):
211        """Gets the ping_url of this RecipientPreviewRequest.  # noqa: E501
212
213          # noqa: E501
214
215        :return: The ping_url of this RecipientPreviewRequest.  # noqa: E501
216        :rtype: str
217        """
218        return self._ping_url
219
220    @ping_url.setter
221    def ping_url(self, ping_url):
222        """Sets the ping_url of this RecipientPreviewRequest.
223
224          # noqa: E501
225
226        :param ping_url: The ping_url of this RecipientPreviewRequest.  # noqa: E501
227        :type: str
228        """
229
230        self._ping_url = ping_url
231
232    @property
233    def recipient_id(self):
234        """Gets the recipient_id of this RecipientPreviewRequest.  # noqa: E501
235
236        Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.  # noqa: E501
237
238        :return: The recipient_id of this RecipientPreviewRequest.  # noqa: E501
239        :rtype: str
240        """
241        return self._recipient_id
242
243    @recipient_id.setter
244    def recipient_id(self, recipient_id):
245        """Sets the recipient_id of this RecipientPreviewRequest.
246
247        Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.  # noqa: E501
248
249        :param recipient_id: The recipient_id of this RecipientPreviewRequest.  # noqa: E501
250        :type: str
251        """
252
253        self._recipient_id = recipient_id
254
255    @property
256    def return_url(self):
257        """Gets the return_url of this RecipientPreviewRequest.  # noqa: E501
258
259          # noqa: E501
260
261        :return: The return_url of this RecipientPreviewRequest.  # noqa: E501
262        :rtype: str
263        """
264        return self._return_url
265
266    @return_url.setter
267    def return_url(self, return_url):
268        """Sets the return_url of this RecipientPreviewRequest.
269
270          # noqa: E501
271
272        :param return_url: The return_url of this RecipientPreviewRequest.  # noqa: E501
273        :type: str
274        """
275
276        self._return_url = return_url
277
278    @property
279    def security_domain(self):
280        """Gets the security_domain of this RecipientPreviewRequest.  # noqa: E501
281
282          # noqa: E501
283
284        :return: The security_domain of this RecipientPreviewRequest.  # noqa: E501
285        :rtype: str
286        """
287        return self._security_domain
288
289    @security_domain.setter
290    def security_domain(self, security_domain):
291        """Sets the security_domain of this RecipientPreviewRequest.
292
293          # noqa: E501
294
295        :param security_domain: The security_domain of this RecipientPreviewRequest.  # noqa: E501
296        :type: str
297        """
298
299        self._security_domain = security_domain
300
301    @property
302    def x_frame_options(self):
303        """Gets the x_frame_options of this RecipientPreviewRequest.  # noqa: E501
304
305          # noqa: E501
306
307        :return: The x_frame_options of this RecipientPreviewRequest.  # noqa: E501
308        :rtype: str
309        """
310        return self._x_frame_options
311
312    @x_frame_options.setter
313    def x_frame_options(self, x_frame_options):
314        """Sets the x_frame_options of this RecipientPreviewRequest.
315
316          # noqa: E501
317
318        :param x_frame_options: The x_frame_options of this RecipientPreviewRequest.  # noqa: E501
319        :type: str
320        """
321
322        self._x_frame_options = x_frame_options
323
324    @property
325    def x_frame_options_allow_from_url(self):
326        """Gets the x_frame_options_allow_from_url of this RecipientPreviewRequest.  # noqa: E501
327
328          # noqa: E501
329
330        :return: The x_frame_options_allow_from_url of this RecipientPreviewRequest.  # noqa: E501
331        :rtype: str
332        """
333        return self._x_frame_options_allow_from_url
334
335    @x_frame_options_allow_from_url.setter
336    def x_frame_options_allow_from_url(self, x_frame_options_allow_from_url):
337        """Sets the x_frame_options_allow_from_url of this RecipientPreviewRequest.
338
339          # noqa: E501
340
341        :param x_frame_options_allow_from_url: The x_frame_options_allow_from_url of this RecipientPreviewRequest.  # noqa: E501
342        :type: str
343        """
344
345        self._x_frame_options_allow_from_url = x_frame_options_allow_from_url
346
347    def to_dict(self):
348        """Returns the model properties as a dict"""
349        result = {}
350
351        for attr, _ in six.iteritems(self.swagger_types):
352            value = getattr(self, attr)
353            if isinstance(value, list):
354                result[attr] = list(map(
355                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
356                    value
357                ))
358            elif hasattr(value, "to_dict"):
359                result[attr] = value.to_dict()
360            elif isinstance(value, dict):
361                result[attr] = dict(map(
362                    lambda item: (item[0], item[1].to_dict())
363                    if hasattr(item[1], "to_dict") else item,
364                    value.items()
365                ))
366            else:
367                result[attr] = value
368        if issubclass(RecipientPreviewRequest, dict):
369            for key, value in self.items():
370                result[key] = value
371
372        return result
373
374    def to_str(self):
375        """Returns the string representation of the model"""
376        return pprint.pformat(self.to_dict())
377
378    def __repr__(self):
379        """For `print` and `pprint`"""
380        return self.to_str()
381
382    def __eq__(self, other):
383        """Returns true if both objects are equal"""
384        if not isinstance(other, RecipientPreviewRequest):
385            return False
386
387        return self.to_dict() == other.to_dict()
388
389    def __ne__(self, other):
390        """Returns true if both objects are not equal"""
391        if not isinstance(other, RecipientPreviewRequest):
392            return True
393
394        return self.to_dict() != other.to_dict()