docusign_esign.models.template_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 TemplateViewSettings(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': 'TemplateViewRecipientSettings',
 41        'show_advanced_options': 'str',
 42        'show_back_button': 'str',
 43        'show_discard_action': 'str',
 44        'show_header_actions': 'str',
 45        'starting_screen': 'str',
 46        'tagger_settings': 'EnvelopeViewTaggerSettings'
 47    }
 48
 49    attribute_map = {
 50        'back_button_action': 'backButtonAction',
 51        'document_settings': 'documentSettings',
 52        'envelope_custom_field_settings': 'envelopeCustomFieldSettings',
 53        'lock_token': 'lockToken',
 54        'recipient_settings': 'recipientSettings',
 55        'show_advanced_options': 'showAdvancedOptions',
 56        'show_back_button': 'showBackButton',
 57        'show_discard_action': 'showDiscardAction',
 58        'show_header_actions': 'showHeaderActions',
 59        'starting_screen': 'startingScreen',
 60        'tagger_settings': 'taggerSettings'
 61    }
 62
 63    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 64        """TemplateViewSettings - a model defined in Swagger"""  # noqa: E501
 65        if _configuration is None:
 66            _configuration = Configuration()
 67        self._configuration = _configuration
 68
 69        self._back_button_action = None
 70        self._document_settings = None
 71        self._envelope_custom_field_settings = None
 72        self._lock_token = None
 73        self._recipient_settings = None
 74        self._show_advanced_options = None
 75        self._show_back_button = None
 76        self._show_discard_action = None
 77        self._show_header_actions = None
 78        self._starting_screen = None
 79        self._tagger_settings = None
 80        self.discriminator = None
 81
 82        setattr(self, "_{}".format('back_button_action'), kwargs.get('back_button_action', None))
 83        setattr(self, "_{}".format('document_settings'), kwargs.get('document_settings', None))
 84        setattr(self, "_{}".format('envelope_custom_field_settings'), kwargs.get('envelope_custom_field_settings', None))
 85        setattr(self, "_{}".format('lock_token'), kwargs.get('lock_token', None))
 86        setattr(self, "_{}".format('recipient_settings'), kwargs.get('recipient_settings', None))
 87        setattr(self, "_{}".format('show_advanced_options'), kwargs.get('show_advanced_options', None))
 88        setattr(self, "_{}".format('show_back_button'), kwargs.get('show_back_button', None))
 89        setattr(self, "_{}".format('show_discard_action'), kwargs.get('show_discard_action', None))
 90        setattr(self, "_{}".format('show_header_actions'), kwargs.get('show_header_actions', None))
 91        setattr(self, "_{}".format('starting_screen'), kwargs.get('starting_screen', None))
 92        setattr(self, "_{}".format('tagger_settings'), kwargs.get('tagger_settings', None))
 93
 94    @property
 95    def back_button_action(self):
 96        """Gets the back_button_action of this TemplateViewSettings.  # noqa: E501
 97
 98          # noqa: E501
 99
100        :return: The back_button_action of this TemplateViewSettings.  # noqa: E501
101        :rtype: str
102        """
103        return self._back_button_action
104
105    @back_button_action.setter
106    def back_button_action(self, back_button_action):
107        """Sets the back_button_action of this TemplateViewSettings.
108
109          # noqa: E501
110
111        :param back_button_action: The back_button_action of this TemplateViewSettings.  # noqa: E501
112        :type: str
113        """
114
115        self._back_button_action = back_button_action
116
117    @property
118    def document_settings(self):
119        """Gets the document_settings of this TemplateViewSettings.  # noqa: E501
120
121          # noqa: E501
122
123        :return: The document_settings of this TemplateViewSettings.  # noqa: E501
124        :rtype: EnvelopeViewDocumentSettings
125        """
126        return self._document_settings
127
128    @document_settings.setter
129    def document_settings(self, document_settings):
130        """Sets the document_settings of this TemplateViewSettings.
131
132          # noqa: E501
133
134        :param document_settings: The document_settings of this TemplateViewSettings.  # noqa: E501
135        :type: EnvelopeViewDocumentSettings
136        """
137
138        self._document_settings = document_settings
139
140    @property
141    def envelope_custom_field_settings(self):
142        """Gets the envelope_custom_field_settings of this TemplateViewSettings.  # noqa: E501
143
144          # noqa: E501
145
146        :return: The envelope_custom_field_settings of this TemplateViewSettings.  # noqa: E501
147        :rtype: EnvelopeViewEnvelopeCustomFieldSettings
148        """
149        return self._envelope_custom_field_settings
150
151    @envelope_custom_field_settings.setter
152    def envelope_custom_field_settings(self, envelope_custom_field_settings):
153        """Sets the envelope_custom_field_settings of this TemplateViewSettings.
154
155          # noqa: E501
156
157        :param envelope_custom_field_settings: The envelope_custom_field_settings of this TemplateViewSettings.  # noqa: E501
158        :type: EnvelopeViewEnvelopeCustomFieldSettings
159        """
160
161        self._envelope_custom_field_settings = envelope_custom_field_settings
162
163    @property
164    def lock_token(self):
165        """Gets the lock_token of this TemplateViewSettings.  # noqa: E501
166
167          # noqa: E501
168
169        :return: The lock_token of this TemplateViewSettings.  # noqa: E501
170        :rtype: str
171        """
172        return self._lock_token
173
174    @lock_token.setter
175    def lock_token(self, lock_token):
176        """Sets the lock_token of this TemplateViewSettings.
177
178          # noqa: E501
179
180        :param lock_token: The lock_token of this TemplateViewSettings.  # noqa: E501
181        :type: str
182        """
183
184        self._lock_token = lock_token
185
186    @property
187    def recipient_settings(self):
188        """Gets the recipient_settings of this TemplateViewSettings.  # noqa: E501
189
190          # noqa: E501
191
192        :return: The recipient_settings of this TemplateViewSettings.  # noqa: E501
193        :rtype: TemplateViewRecipientSettings
194        """
195        return self._recipient_settings
196
197    @recipient_settings.setter
198    def recipient_settings(self, recipient_settings):
199        """Sets the recipient_settings of this TemplateViewSettings.
200
201          # noqa: E501
202
203        :param recipient_settings: The recipient_settings of this TemplateViewSettings.  # noqa: E501
204        :type: TemplateViewRecipientSettings
205        """
206
207        self._recipient_settings = recipient_settings
208
209    @property
210    def show_advanced_options(self):
211        """Gets the show_advanced_options of this TemplateViewSettings.  # noqa: E501
212
213          # noqa: E501
214
215        :return: The show_advanced_options of this TemplateViewSettings.  # noqa: E501
216        :rtype: str
217        """
218        return self._show_advanced_options
219
220    @show_advanced_options.setter
221    def show_advanced_options(self, show_advanced_options):
222        """Sets the show_advanced_options of this TemplateViewSettings.
223
224          # noqa: E501
225
226        :param show_advanced_options: The show_advanced_options of this TemplateViewSettings.  # noqa: E501
227        :type: str
228        """
229
230        self._show_advanced_options = show_advanced_options
231
232    @property
233    def show_back_button(self):
234        """Gets the show_back_button of this TemplateViewSettings.  # noqa: E501
235
236          # noqa: E501
237
238        :return: The show_back_button of this TemplateViewSettings.  # noqa: E501
239        :rtype: str
240        """
241        return self._show_back_button
242
243    @show_back_button.setter
244    def show_back_button(self, show_back_button):
245        """Sets the show_back_button of this TemplateViewSettings.
246
247          # noqa: E501
248
249        :param show_back_button: The show_back_button of this TemplateViewSettings.  # noqa: E501
250        :type: str
251        """
252
253        self._show_back_button = show_back_button
254
255    @property
256    def show_discard_action(self):
257        """Gets the show_discard_action of this TemplateViewSettings.  # noqa: E501
258
259          # noqa: E501
260
261        :return: The show_discard_action of this TemplateViewSettings.  # noqa: E501
262        :rtype: str
263        """
264        return self._show_discard_action
265
266    @show_discard_action.setter
267    def show_discard_action(self, show_discard_action):
268        """Sets the show_discard_action of this TemplateViewSettings.
269
270          # noqa: E501
271
272        :param show_discard_action: The show_discard_action of this TemplateViewSettings.  # noqa: E501
273        :type: str
274        """
275
276        self._show_discard_action = show_discard_action
277
278    @property
279    def show_header_actions(self):
280        """Gets the show_header_actions of this TemplateViewSettings.  # noqa: E501
281
282          # noqa: E501
283
284        :return: The show_header_actions of this TemplateViewSettings.  # noqa: E501
285        :rtype: str
286        """
287        return self._show_header_actions
288
289    @show_header_actions.setter
290    def show_header_actions(self, show_header_actions):
291        """Sets the show_header_actions of this TemplateViewSettings.
292
293          # noqa: E501
294
295        :param show_header_actions: The show_header_actions of this TemplateViewSettings.  # noqa: E501
296        :type: str
297        """
298
299        self._show_header_actions = show_header_actions
300
301    @property
302    def starting_screen(self):
303        """Gets the starting_screen of this TemplateViewSettings.  # noqa: E501
304
305          # noqa: E501
306
307        :return: The starting_screen of this TemplateViewSettings.  # noqa: E501
308        :rtype: str
309        """
310        return self._starting_screen
311
312    @starting_screen.setter
313    def starting_screen(self, starting_screen):
314        """Sets the starting_screen of this TemplateViewSettings.
315
316          # noqa: E501
317
318        :param starting_screen: The starting_screen of this TemplateViewSettings.  # noqa: E501
319        :type: str
320        """
321
322        self._starting_screen = starting_screen
323
324    @property
325    def tagger_settings(self):
326        """Gets the tagger_settings of this TemplateViewSettings.  # noqa: E501
327
328          # noqa: E501
329
330        :return: The tagger_settings of this TemplateViewSettings.  # noqa: E501
331        :rtype: EnvelopeViewTaggerSettings
332        """
333        return self._tagger_settings
334
335    @tagger_settings.setter
336    def tagger_settings(self, tagger_settings):
337        """Sets the tagger_settings of this TemplateViewSettings.
338
339          # noqa: E501
340
341        :param tagger_settings: The tagger_settings of this TemplateViewSettings.  # noqa: E501
342        :type: EnvelopeViewTaggerSettings
343        """
344
345        self._tagger_settings = tagger_settings
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(TemplateViewSettings, 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, TemplateViewSettings):
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, TemplateViewSettings):
392            return True
393
394        return self.to_dict() != other.to_dict()