docusign_esign.models.document_html_definition

  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 DocumentHtmlDefinition(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        'display_anchor_prefix': 'str',
 37        'display_anchors': 'list[DocumentHtmlDisplayAnchor]',
 38        'display_order': 'str',
 39        'display_page_number': 'str',
 40        'document_guid': 'str',
 41        'document_id': 'str',
 42        'header_label': 'str',
 43        'max_screen_width': 'str',
 44        'remove_empty_tags': 'str',
 45        'show_mobile_optimized_toggle': 'str',
 46        'source': 'str'
 47    }
 48
 49    attribute_map = {
 50        'display_anchor_prefix': 'displayAnchorPrefix',
 51        'display_anchors': 'displayAnchors',
 52        'display_order': 'displayOrder',
 53        'display_page_number': 'displayPageNumber',
 54        'document_guid': 'documentGuid',
 55        'document_id': 'documentId',
 56        'header_label': 'headerLabel',
 57        'max_screen_width': 'maxScreenWidth',
 58        'remove_empty_tags': 'removeEmptyTags',
 59        'show_mobile_optimized_toggle': 'showMobileOptimizedToggle',
 60        'source': 'source'
 61    }
 62
 63    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 64        """DocumentHtmlDefinition - a model defined in Swagger"""  # noqa: E501
 65        if _configuration is None:
 66            _configuration = Configuration()
 67        self._configuration = _configuration
 68
 69        self._display_anchor_prefix = None
 70        self._display_anchors = None
 71        self._display_order = None
 72        self._display_page_number = None
 73        self._document_guid = None
 74        self._document_id = None
 75        self._header_label = None
 76        self._max_screen_width = None
 77        self._remove_empty_tags = None
 78        self._show_mobile_optimized_toggle = None
 79        self._source = None
 80        self.discriminator = None
 81
 82        setattr(self, "_{}".format('display_anchor_prefix'), kwargs.get('display_anchor_prefix', None))
 83        setattr(self, "_{}".format('display_anchors'), kwargs.get('display_anchors', None))
 84        setattr(self, "_{}".format('display_order'), kwargs.get('display_order', None))
 85        setattr(self, "_{}".format('display_page_number'), kwargs.get('display_page_number', None))
 86        setattr(self, "_{}".format('document_guid'), kwargs.get('document_guid', None))
 87        setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None))
 88        setattr(self, "_{}".format('header_label'), kwargs.get('header_label', None))
 89        setattr(self, "_{}".format('max_screen_width'), kwargs.get('max_screen_width', None))
 90        setattr(self, "_{}".format('remove_empty_tags'), kwargs.get('remove_empty_tags', None))
 91        setattr(self, "_{}".format('show_mobile_optimized_toggle'), kwargs.get('show_mobile_optimized_toggle', None))
 92        setattr(self, "_{}".format('source'), kwargs.get('source', None))
 93
 94    @property
 95    def display_anchor_prefix(self):
 96        """Gets the display_anchor_prefix of this DocumentHtmlDefinition.  # noqa: E501
 97
 98          # noqa: E501
 99
100        :return: The display_anchor_prefix of this DocumentHtmlDefinition.  # noqa: E501
101        :rtype: str
102        """
103        return self._display_anchor_prefix
104
105    @display_anchor_prefix.setter
106    def display_anchor_prefix(self, display_anchor_prefix):
107        """Sets the display_anchor_prefix of this DocumentHtmlDefinition.
108
109          # noqa: E501
110
111        :param display_anchor_prefix: The display_anchor_prefix of this DocumentHtmlDefinition.  # noqa: E501
112        :type: str
113        """
114
115        self._display_anchor_prefix = display_anchor_prefix
116
117    @property
118    def display_anchors(self):
119        """Gets the display_anchors of this DocumentHtmlDefinition.  # noqa: E501
120
121          # noqa: E501
122
123        :return: The display_anchors of this DocumentHtmlDefinition.  # noqa: E501
124        :rtype: list[DocumentHtmlDisplayAnchor]
125        """
126        return self._display_anchors
127
128    @display_anchors.setter
129    def display_anchors(self, display_anchors):
130        """Sets the display_anchors of this DocumentHtmlDefinition.
131
132          # noqa: E501
133
134        :param display_anchors: The display_anchors of this DocumentHtmlDefinition.  # noqa: E501
135        :type: list[DocumentHtmlDisplayAnchor]
136        """
137
138        self._display_anchors = display_anchors
139
140    @property
141    def display_order(self):
142        """Gets the display_order of this DocumentHtmlDefinition.  # noqa: E501
143
144          # noqa: E501
145
146        :return: The display_order of this DocumentHtmlDefinition.  # noqa: E501
147        :rtype: str
148        """
149        return self._display_order
150
151    @display_order.setter
152    def display_order(self, display_order):
153        """Sets the display_order of this DocumentHtmlDefinition.
154
155          # noqa: E501
156
157        :param display_order: The display_order of this DocumentHtmlDefinition.  # noqa: E501
158        :type: str
159        """
160
161        self._display_order = display_order
162
163    @property
164    def display_page_number(self):
165        """Gets the display_page_number of this DocumentHtmlDefinition.  # noqa: E501
166
167          # noqa: E501
168
169        :return: The display_page_number of this DocumentHtmlDefinition.  # noqa: E501
170        :rtype: str
171        """
172        return self._display_page_number
173
174    @display_page_number.setter
175    def display_page_number(self, display_page_number):
176        """Sets the display_page_number of this DocumentHtmlDefinition.
177
178          # noqa: E501
179
180        :param display_page_number: The display_page_number of this DocumentHtmlDefinition.  # noqa: E501
181        :type: str
182        """
183
184        self._display_page_number = display_page_number
185
186    @property
187    def document_guid(self):
188        """Gets the document_guid of this DocumentHtmlDefinition.  # noqa: E501
189
190          # noqa: E501
191
192        :return: The document_guid of this DocumentHtmlDefinition.  # noqa: E501
193        :rtype: str
194        """
195        return self._document_guid
196
197    @document_guid.setter
198    def document_guid(self, document_guid):
199        """Sets the document_guid of this DocumentHtmlDefinition.
200
201          # noqa: E501
202
203        :param document_guid: The document_guid of this DocumentHtmlDefinition.  # noqa: E501
204        :type: str
205        """
206
207        self._document_guid = document_guid
208
209    @property
210    def document_id(self):
211        """Gets the document_id of this DocumentHtmlDefinition.  # noqa: E501
212
213        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.  # noqa: E501
214
215        :return: The document_id of this DocumentHtmlDefinition.  # noqa: E501
216        :rtype: str
217        """
218        return self._document_id
219
220    @document_id.setter
221    def document_id(self, document_id):
222        """Sets the document_id of this DocumentHtmlDefinition.
223
224        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.  # noqa: E501
225
226        :param document_id: The document_id of this DocumentHtmlDefinition.  # noqa: E501
227        :type: str
228        """
229
230        self._document_id = document_id
231
232    @property
233    def header_label(self):
234        """Gets the header_label of this DocumentHtmlDefinition.  # noqa: E501
235
236          # noqa: E501
237
238        :return: The header_label of this DocumentHtmlDefinition.  # noqa: E501
239        :rtype: str
240        """
241        return self._header_label
242
243    @header_label.setter
244    def header_label(self, header_label):
245        """Sets the header_label of this DocumentHtmlDefinition.
246
247          # noqa: E501
248
249        :param header_label: The header_label of this DocumentHtmlDefinition.  # noqa: E501
250        :type: str
251        """
252
253        self._header_label = header_label
254
255    @property
256    def max_screen_width(self):
257        """Gets the max_screen_width of this DocumentHtmlDefinition.  # noqa: E501
258
259          # noqa: E501
260
261        :return: The max_screen_width of this DocumentHtmlDefinition.  # noqa: E501
262        :rtype: str
263        """
264        return self._max_screen_width
265
266    @max_screen_width.setter
267    def max_screen_width(self, max_screen_width):
268        """Sets the max_screen_width of this DocumentHtmlDefinition.
269
270          # noqa: E501
271
272        :param max_screen_width: The max_screen_width of this DocumentHtmlDefinition.  # noqa: E501
273        :type: str
274        """
275
276        self._max_screen_width = max_screen_width
277
278    @property
279    def remove_empty_tags(self):
280        """Gets the remove_empty_tags of this DocumentHtmlDefinition.  # noqa: E501
281
282          # noqa: E501
283
284        :return: The remove_empty_tags of this DocumentHtmlDefinition.  # noqa: E501
285        :rtype: str
286        """
287        return self._remove_empty_tags
288
289    @remove_empty_tags.setter
290    def remove_empty_tags(self, remove_empty_tags):
291        """Sets the remove_empty_tags of this DocumentHtmlDefinition.
292
293          # noqa: E501
294
295        :param remove_empty_tags: The remove_empty_tags of this DocumentHtmlDefinition.  # noqa: E501
296        :type: str
297        """
298
299        self._remove_empty_tags = remove_empty_tags
300
301    @property
302    def show_mobile_optimized_toggle(self):
303        """Gets the show_mobile_optimized_toggle of this DocumentHtmlDefinition.  # noqa: E501
304
305          # noqa: E501
306
307        :return: The show_mobile_optimized_toggle of this DocumentHtmlDefinition.  # noqa: E501
308        :rtype: str
309        """
310        return self._show_mobile_optimized_toggle
311
312    @show_mobile_optimized_toggle.setter
313    def show_mobile_optimized_toggle(self, show_mobile_optimized_toggle):
314        """Sets the show_mobile_optimized_toggle of this DocumentHtmlDefinition.
315
316          # noqa: E501
317
318        :param show_mobile_optimized_toggle: The show_mobile_optimized_toggle of this DocumentHtmlDefinition.  # noqa: E501
319        :type: str
320        """
321
322        self._show_mobile_optimized_toggle = show_mobile_optimized_toggle
323
324    @property
325    def source(self):
326        """Gets the source of this DocumentHtmlDefinition.  # noqa: E501
327
328          # noqa: E501
329
330        :return: The source of this DocumentHtmlDefinition.  # noqa: E501
331        :rtype: str
332        """
333        return self._source
334
335    @source.setter
336    def source(self, source):
337        """Sets the source of this DocumentHtmlDefinition.
338
339          # noqa: E501
340
341        :param source: The source of this DocumentHtmlDefinition.  # noqa: E501
342        :type: str
343        """
344
345        self._source = source
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(DocumentHtmlDefinition, 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, DocumentHtmlDefinition):
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, DocumentHtmlDefinition):
392            return True
393
394        return self.to_dict() != other.to_dict()