docusign_esign.models.envelope_view_settings

  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 EnvelopeViewSettings(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        'back_button_action': 'str',
 37        'document_settings': 'EnvelopeViewDocumentSettings',
 38        'envelope_custom_field_settings': 'EnvelopeViewEnvelopeCustomFieldSettings',
 39        'lock_token': 'str',
 40        'recipient_settings': 'EnvelopeViewRecipientSettings',
 41        'send_button_action': 'str',
 42        'show_advanced_options': 'str',
 43        'show_back_button': 'str',
 44        'show_discard_action': 'str',
 45        'show_header_actions': 'str',
 46        'show_sign_now': 'str',
 47        'starting_screen': 'str',
 48        'tagger_settings': 'EnvelopeViewTaggerSettings',
 49        'template_settings': 'EnvelopeViewTemplateSettings'
 50    }
 51
 52    attribute_map = {
 53        'back_button_action': 'backButtonAction',
 54        'document_settings': 'documentSettings',
 55        'envelope_custom_field_settings': 'envelopeCustomFieldSettings',
 56        'lock_token': 'lockToken',
 57        'recipient_settings': 'recipientSettings',
 58        'send_button_action': 'sendButtonAction',
 59        'show_advanced_options': 'showAdvancedOptions',
 60        'show_back_button': 'showBackButton',
 61        'show_discard_action': 'showDiscardAction',
 62        'show_header_actions': 'showHeaderActions',
 63        'show_sign_now': 'showSignNow',
 64        'starting_screen': 'startingScreen',
 65        'tagger_settings': 'taggerSettings',
 66        'template_settings': 'templateSettings'
 67    }
 68
 69    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 70        """EnvelopeViewSettings - a model defined in Swagger"""  # noqa: E501
 71        if _configuration is None:
 72            _configuration = Configuration()
 73        self._configuration = _configuration
 74
 75        self._back_button_action = None
 76        self._document_settings = None
 77        self._envelope_custom_field_settings = None
 78        self._lock_token = None
 79        self._recipient_settings = None
 80        self._send_button_action = None
 81        self._show_advanced_options = None
 82        self._show_back_button = None
 83        self._show_discard_action = None
 84        self._show_header_actions = None
 85        self._show_sign_now = None
 86        self._starting_screen = None
 87        self._tagger_settings = None
 88        self._template_settings = None
 89        self.discriminator = None
 90
 91        setattr(self, "_{}".format('back_button_action'), kwargs.get('back_button_action', None))
 92        setattr(self, "_{}".format('document_settings'), kwargs.get('document_settings', None))
 93        setattr(self, "_{}".format('envelope_custom_field_settings'), kwargs.get('envelope_custom_field_settings', None))
 94        setattr(self, "_{}".format('lock_token'), kwargs.get('lock_token', None))
 95        setattr(self, "_{}".format('recipient_settings'), kwargs.get('recipient_settings', None))
 96        setattr(self, "_{}".format('send_button_action'), kwargs.get('send_button_action', None))
 97        setattr(self, "_{}".format('show_advanced_options'), kwargs.get('show_advanced_options', None))
 98        setattr(self, "_{}".format('show_back_button'), kwargs.get('show_back_button', None))
 99        setattr(self, "_{}".format('show_discard_action'), kwargs.get('show_discard_action', None))
100        setattr(self, "_{}".format('show_header_actions'), kwargs.get('show_header_actions', None))
101        setattr(self, "_{}".format('show_sign_now'), kwargs.get('show_sign_now', None))
102        setattr(self, "_{}".format('starting_screen'), kwargs.get('starting_screen', None))
103        setattr(self, "_{}".format('tagger_settings'), kwargs.get('tagger_settings', None))
104        setattr(self, "_{}".format('template_settings'), kwargs.get('template_settings', None))
105
106    @property
107    def back_button_action(self):
108        """Gets the back_button_action of this EnvelopeViewSettings.  # noqa: E501
109
110          # noqa: E501
111
112        :return: The back_button_action of this EnvelopeViewSettings.  # noqa: E501
113        :rtype: str
114        """
115        return self._back_button_action
116
117    @back_button_action.setter
118    def back_button_action(self, back_button_action):
119        """Sets the back_button_action of this EnvelopeViewSettings.
120
121          # noqa: E501
122
123        :param back_button_action: The back_button_action of this EnvelopeViewSettings.  # noqa: E501
124        :type: str
125        """
126
127        self._back_button_action = back_button_action
128
129    @property
130    def document_settings(self):
131        """Gets the document_settings of this EnvelopeViewSettings.  # noqa: E501
132
133          # noqa: E501
134
135        :return: The document_settings of this EnvelopeViewSettings.  # noqa: E501
136        :rtype: EnvelopeViewDocumentSettings
137        """
138        return self._document_settings
139
140    @document_settings.setter
141    def document_settings(self, document_settings):
142        """Sets the document_settings of this EnvelopeViewSettings.
143
144          # noqa: E501
145
146        :param document_settings: The document_settings of this EnvelopeViewSettings.  # noqa: E501
147        :type: EnvelopeViewDocumentSettings
148        """
149
150        self._document_settings = document_settings
151
152    @property
153    def envelope_custom_field_settings(self):
154        """Gets the envelope_custom_field_settings of this EnvelopeViewSettings.  # noqa: E501
155
156          # noqa: E501
157
158        :return: The envelope_custom_field_settings of this EnvelopeViewSettings.  # noqa: E501
159        :rtype: EnvelopeViewEnvelopeCustomFieldSettings
160        """
161        return self._envelope_custom_field_settings
162
163    @envelope_custom_field_settings.setter
164    def envelope_custom_field_settings(self, envelope_custom_field_settings):
165        """Sets the envelope_custom_field_settings of this EnvelopeViewSettings.
166
167          # noqa: E501
168
169        :param envelope_custom_field_settings: The envelope_custom_field_settings of this EnvelopeViewSettings.  # noqa: E501
170        :type: EnvelopeViewEnvelopeCustomFieldSettings
171        """
172
173        self._envelope_custom_field_settings = envelope_custom_field_settings
174
175    @property
176    def lock_token(self):
177        """Gets the lock_token of this EnvelopeViewSettings.  # noqa: E501
178
179          # noqa: E501
180
181        :return: The lock_token of this EnvelopeViewSettings.  # noqa: E501
182        :rtype: str
183        """
184        return self._lock_token
185
186    @lock_token.setter
187    def lock_token(self, lock_token):
188        """Sets the lock_token of this EnvelopeViewSettings.
189
190          # noqa: E501
191
192        :param lock_token: The lock_token of this EnvelopeViewSettings.  # noqa: E501
193        :type: str
194        """
195
196        self._lock_token = lock_token
197
198    @property
199    def recipient_settings(self):
200        """Gets the recipient_settings of this EnvelopeViewSettings.  # noqa: E501
201
202          # noqa: E501
203
204        :return: The recipient_settings of this EnvelopeViewSettings.  # noqa: E501
205        :rtype: EnvelopeViewRecipientSettings
206        """
207        return self._recipient_settings
208
209    @recipient_settings.setter
210    def recipient_settings(self, recipient_settings):
211        """Sets the recipient_settings of this EnvelopeViewSettings.
212
213          # noqa: E501
214
215        :param recipient_settings: The recipient_settings of this EnvelopeViewSettings.  # noqa: E501
216        :type: EnvelopeViewRecipientSettings
217        """
218
219        self._recipient_settings = recipient_settings
220
221    @property
222    def send_button_action(self):
223        """Gets the send_button_action of this EnvelopeViewSettings.  # noqa: E501
224
225          # noqa: E501
226
227        :return: The send_button_action of this EnvelopeViewSettings.  # noqa: E501
228        :rtype: str
229        """
230        return self._send_button_action
231
232    @send_button_action.setter
233    def send_button_action(self, send_button_action):
234        """Sets the send_button_action of this EnvelopeViewSettings.
235
236          # noqa: E501
237
238        :param send_button_action: The send_button_action of this EnvelopeViewSettings.  # noqa: E501
239        :type: str
240        """
241
242        self._send_button_action = send_button_action
243
244    @property
245    def show_advanced_options(self):
246        """Gets the show_advanced_options of this EnvelopeViewSettings.  # noqa: E501
247
248          # noqa: E501
249
250        :return: The show_advanced_options of this EnvelopeViewSettings.  # noqa: E501
251        :rtype: str
252        """
253        return self._show_advanced_options
254
255    @show_advanced_options.setter
256    def show_advanced_options(self, show_advanced_options):
257        """Sets the show_advanced_options of this EnvelopeViewSettings.
258
259          # noqa: E501
260
261        :param show_advanced_options: The show_advanced_options of this EnvelopeViewSettings.  # noqa: E501
262        :type: str
263        """
264
265        self._show_advanced_options = show_advanced_options
266
267    @property
268    def show_back_button(self):
269        """Gets the show_back_button of this EnvelopeViewSettings.  # noqa: E501
270
271          # noqa: E501
272
273        :return: The show_back_button of this EnvelopeViewSettings.  # noqa: E501
274        :rtype: str
275        """
276        return self._show_back_button
277
278    @show_back_button.setter
279    def show_back_button(self, show_back_button):
280        """Sets the show_back_button of this EnvelopeViewSettings.
281
282          # noqa: E501
283
284        :param show_back_button: The show_back_button of this EnvelopeViewSettings.  # noqa: E501
285        :type: str
286        """
287
288        self._show_back_button = show_back_button
289
290    @property
291    def show_discard_action(self):
292        """Gets the show_discard_action of this EnvelopeViewSettings.  # noqa: E501
293
294          # noqa: E501
295
296        :return: The show_discard_action of this EnvelopeViewSettings.  # noqa: E501
297        :rtype: str
298        """
299        return self._show_discard_action
300
301    @show_discard_action.setter
302    def show_discard_action(self, show_discard_action):
303        """Sets the show_discard_action of this EnvelopeViewSettings.
304
305          # noqa: E501
306
307        :param show_discard_action: The show_discard_action of this EnvelopeViewSettings.  # noqa: E501
308        :type: str
309        """
310
311        self._show_discard_action = show_discard_action
312
313    @property
314    def show_header_actions(self):
315        """Gets the show_header_actions of this EnvelopeViewSettings.  # noqa: E501
316
317          # noqa: E501
318
319        :return: The show_header_actions of this EnvelopeViewSettings.  # noqa: E501
320        :rtype: str
321        """
322        return self._show_header_actions
323
324    @show_header_actions.setter
325    def show_header_actions(self, show_header_actions):
326        """Sets the show_header_actions of this EnvelopeViewSettings.
327
328          # noqa: E501
329
330        :param show_header_actions: The show_header_actions of this EnvelopeViewSettings.  # noqa: E501
331        :type: str
332        """
333
334        self._show_header_actions = show_header_actions
335
336    @property
337    def show_sign_now(self):
338        """Gets the show_sign_now of this EnvelopeViewSettings.  # noqa: E501
339
340          # noqa: E501
341
342        :return: The show_sign_now of this EnvelopeViewSettings.  # noqa: E501
343        :rtype: str
344        """
345        return self._show_sign_now
346
347    @show_sign_now.setter
348    def show_sign_now(self, show_sign_now):
349        """Sets the show_sign_now of this EnvelopeViewSettings.
350
351          # noqa: E501
352
353        :param show_sign_now: The show_sign_now of this EnvelopeViewSettings.  # noqa: E501
354        :type: str
355        """
356
357        self._show_sign_now = show_sign_now
358
359    @property
360    def starting_screen(self):
361        """Gets the starting_screen of this EnvelopeViewSettings.  # noqa: E501
362
363          # noqa: E501
364
365        :return: The starting_screen of this EnvelopeViewSettings.  # noqa: E501
366        :rtype: str
367        """
368        return self._starting_screen
369
370    @starting_screen.setter
371    def starting_screen(self, starting_screen):
372        """Sets the starting_screen of this EnvelopeViewSettings.
373
374          # noqa: E501
375
376        :param starting_screen: The starting_screen of this EnvelopeViewSettings.  # noqa: E501
377        :type: str
378        """
379
380        self._starting_screen = starting_screen
381
382    @property
383    def tagger_settings(self):
384        """Gets the tagger_settings of this EnvelopeViewSettings.  # noqa: E501
385
386          # noqa: E501
387
388        :return: The tagger_settings of this EnvelopeViewSettings.  # noqa: E501
389        :rtype: EnvelopeViewTaggerSettings
390        """
391        return self._tagger_settings
392
393    @tagger_settings.setter
394    def tagger_settings(self, tagger_settings):
395        """Sets the tagger_settings of this EnvelopeViewSettings.
396
397          # noqa: E501
398
399        :param tagger_settings: The tagger_settings of this EnvelopeViewSettings.  # noqa: E501
400        :type: EnvelopeViewTaggerSettings
401        """
402
403        self._tagger_settings = tagger_settings
404
405    @property
406    def template_settings(self):
407        """Gets the template_settings of this EnvelopeViewSettings.  # noqa: E501
408
409          # noqa: E501
410
411        :return: The template_settings of this EnvelopeViewSettings.  # noqa: E501
412        :rtype: EnvelopeViewTemplateSettings
413        """
414        return self._template_settings
415
416    @template_settings.setter
417    def template_settings(self, template_settings):
418        """Sets the template_settings of this EnvelopeViewSettings.
419
420          # noqa: E501
421
422        :param template_settings: The template_settings of this EnvelopeViewSettings.  # noqa: E501
423        :type: EnvelopeViewTemplateSettings
424        """
425
426        self._template_settings = template_settings
427
428    def to_dict(self):
429        """Returns the model properties as a dict"""
430        result = {}
431
432        for attr, _ in six.iteritems(self.swagger_types):
433            value = getattr(self, attr)
434            if isinstance(value, list):
435                result[attr] = list(map(
436                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
437                    value
438                ))
439            elif hasattr(value, "to_dict"):
440                result[attr] = value.to_dict()
441            elif isinstance(value, dict):
442                result[attr] = dict(map(
443                    lambda item: (item[0], item[1].to_dict())
444                    if hasattr(item[1], "to_dict") else item,
445                    value.items()
446                ))
447            else:
448                result[attr] = value
449        if issubclass(EnvelopeViewSettings, dict):
450            for key, value in self.items():
451                result[key] = value
452
453        return result
454
455    def to_str(self):
456        """Returns the string representation of the model"""
457        return pprint.pformat(self.to_dict())
458
459    def __repr__(self):
460        """For `print` and `pprint`"""
461        return self.to_str()
462
463    def __eq__(self, other):
464        """Returns true if both objects are equal"""
465        if not isinstance(other, EnvelopeViewSettings):
466            return False
467
468        return self.to_dict() == other.to_dict()
469
470    def __ne__(self, other):
471        """Returns true if both objects are not equal"""
472        if not isinstance(other, EnvelopeViewSettings):
473            return True
474
475        return self.to_dict() != other.to_dict()