docusign_esign.models.display_appliance_document_page

DocuSign REST API

The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.

OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git

View Source

  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.
  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
 14from pprint import pformat
 15from six import iteritems
 16import re
 17
 18
 19class DisplayApplianceDocumentPage(object):
 20    """
 21    NOTE: This class is auto generated by the swagger code generator program.
 22    Do not edit the class manually.
 23    """
 24    def __init__(self, doc_page_count_total=None, document_id=None, document_name=None, extension=None, height72_dpi=None, is_attachment_type=None, page=None, page_id=None, type=None, width72_dpi=None):
 25        """
 26        DisplayApplianceDocumentPage - a model defined in Swagger
 27
 28        :param dict swaggerTypes: The key is attribute name
 29                                  and the value is attribute type.
 30        :param dict attributeMap: The key is attribute name
 31                                  and the value is json key in definition.
 32        """
 33        self.swagger_types = {
 34            'doc_page_count_total': 'int',
 35            'document_id': 'str',
 36            'document_name': 'str',
 37            'extension': 'str',
 38            'height72_dpi': 'int',
 39            'is_attachment_type': 'bool',
 40            'page': 'int',
 41            'page_id': 'str',
 42            'type': 'str',
 43            'width72_dpi': 'int'
 44        }
 45
 46        self.attribute_map = {
 47            'doc_page_count_total': 'docPageCountTotal',
 48            'document_id': 'documentId',
 49            'document_name': 'documentName',
 50            'extension': 'extension',
 51            'height72_dpi': 'height72DPI',
 52            'is_attachment_type': 'isAttachmentType',
 53            'page': 'page',
 54            'page_id': 'pageId',
 55            'type': 'type',
 56            'width72_dpi': 'width72DPI'
 57        }
 58
 59        self._doc_page_count_total = doc_page_count_total
 60        self._document_id = document_id
 61        self._document_name = document_name
 62        self._extension = extension
 63        self._height72_dpi = height72_dpi
 64        self._is_attachment_type = is_attachment_type
 65        self._page = page
 66        self._page_id = page_id
 67        self._type = type
 68        self._width72_dpi = width72_dpi
 69
 70    @property
 71    def doc_page_count_total(self):
 72        """
 73        Gets the doc_page_count_total of this DisplayApplianceDocumentPage.
 74        
 75
 76        :return: The doc_page_count_total of this DisplayApplianceDocumentPage.
 77        :rtype: int
 78        """
 79        return self._doc_page_count_total
 80
 81    @doc_page_count_total.setter
 82    def doc_page_count_total(self, doc_page_count_total):
 83        """
 84        Sets the doc_page_count_total of this DisplayApplianceDocumentPage.
 85        
 86
 87        :param doc_page_count_total: The doc_page_count_total of this DisplayApplianceDocumentPage.
 88        :type: int
 89        """
 90
 91        self._doc_page_count_total = doc_page_count_total
 92
 93    @property
 94    def document_id(self):
 95        """
 96        Gets the document_id of this DisplayApplianceDocumentPage.
 97        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
 98
 99        :return: The document_id of this DisplayApplianceDocumentPage.
100        :rtype: str
101        """
102        return self._document_id
103
104    @document_id.setter
105    def document_id(self, document_id):
106        """
107        Sets the document_id of this DisplayApplianceDocumentPage.
108        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
109
110        :param document_id: The document_id of this DisplayApplianceDocumentPage.
111        :type: str
112        """
113
114        self._document_id = document_id
115
116    @property
117    def document_name(self):
118        """
119        Gets the document_name of this DisplayApplianceDocumentPage.
120        
121
122        :return: The document_name of this DisplayApplianceDocumentPage.
123        :rtype: str
124        """
125        return self._document_name
126
127    @document_name.setter
128    def document_name(self, document_name):
129        """
130        Sets the document_name of this DisplayApplianceDocumentPage.
131        
132
133        :param document_name: The document_name of this DisplayApplianceDocumentPage.
134        :type: str
135        """
136
137        self._document_name = document_name
138
139    @property
140    def extension(self):
141        """
142        Gets the extension of this DisplayApplianceDocumentPage.
143        
144
145        :return: The extension of this DisplayApplianceDocumentPage.
146        :rtype: str
147        """
148        return self._extension
149
150    @extension.setter
151    def extension(self, extension):
152        """
153        Sets the extension of this DisplayApplianceDocumentPage.
154        
155
156        :param extension: The extension of this DisplayApplianceDocumentPage.
157        :type: str
158        """
159
160        self._extension = extension
161
162    @property
163    def height72_dpi(self):
164        """
165        Gets the height72_dpi of this DisplayApplianceDocumentPage.
166        
167
168        :return: The height72_dpi of this DisplayApplianceDocumentPage.
169        :rtype: int
170        """
171        return self._height72_dpi
172
173    @height72_dpi.setter
174    def height72_dpi(self, height72_dpi):
175        """
176        Sets the height72_dpi of this DisplayApplianceDocumentPage.
177        
178
179        :param height72_dpi: The height72_dpi of this DisplayApplianceDocumentPage.
180        :type: int
181        """
182
183        self._height72_dpi = height72_dpi
184
185    @property
186    def is_attachment_type(self):
187        """
188        Gets the is_attachment_type of this DisplayApplianceDocumentPage.
189        
190
191        :return: The is_attachment_type of this DisplayApplianceDocumentPage.
192        :rtype: bool
193        """
194        return self._is_attachment_type
195
196    @is_attachment_type.setter
197    def is_attachment_type(self, is_attachment_type):
198        """
199        Sets the is_attachment_type of this DisplayApplianceDocumentPage.
200        
201
202        :param is_attachment_type: The is_attachment_type of this DisplayApplianceDocumentPage.
203        :type: bool
204        """
205
206        self._is_attachment_type = is_attachment_type
207
208    @property
209    def page(self):
210        """
211        Gets the page of this DisplayApplianceDocumentPage.
212        
213
214        :return: The page of this DisplayApplianceDocumentPage.
215        :rtype: int
216        """
217        return self._page
218
219    @page.setter
220    def page(self, page):
221        """
222        Sets the page of this DisplayApplianceDocumentPage.
223        
224
225        :param page: The page of this DisplayApplianceDocumentPage.
226        :type: int
227        """
228
229        self._page = page
230
231    @property
232    def page_id(self):
233        """
234        Gets the page_id of this DisplayApplianceDocumentPage.
235        
236
237        :return: The page_id of this DisplayApplianceDocumentPage.
238        :rtype: str
239        """
240        return self._page_id
241
242    @page_id.setter
243    def page_id(self, page_id):
244        """
245        Sets the page_id of this DisplayApplianceDocumentPage.
246        
247
248        :param page_id: The page_id of this DisplayApplianceDocumentPage.
249        :type: str
250        """
251
252        self._page_id = page_id
253
254    @property
255    def type(self):
256        """
257        Gets the type of this DisplayApplianceDocumentPage.
258        
259
260        :return: The type of this DisplayApplianceDocumentPage.
261        :rtype: str
262        """
263        return self._type
264
265    @type.setter
266    def type(self, type):
267        """
268        Sets the type of this DisplayApplianceDocumentPage.
269        
270
271        :param type: The type of this DisplayApplianceDocumentPage.
272        :type: str
273        """
274
275        self._type = type
276
277    @property
278    def width72_dpi(self):
279        """
280        Gets the width72_dpi of this DisplayApplianceDocumentPage.
281        
282
283        :return: The width72_dpi of this DisplayApplianceDocumentPage.
284        :rtype: int
285        """
286        return self._width72_dpi
287
288    @width72_dpi.setter
289    def width72_dpi(self, width72_dpi):
290        """
291        Sets the width72_dpi of this DisplayApplianceDocumentPage.
292        
293
294        :param width72_dpi: The width72_dpi of this DisplayApplianceDocumentPage.
295        :type: int
296        """
297
298        self._width72_dpi = width72_dpi
299
300    def to_dict(self):
301        """
302        Returns the model properties as a dict
303        """
304        result = {}
305
306        for attr, _ in iteritems(self.swagger_types):
307            value = getattr(self, attr)
308            if isinstance(value, list):
309                result[attr] = list(map(
310                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
311                    value
312                ))
313            elif hasattr(value, "to_dict"):
314                result[attr] = value.to_dict()
315            elif isinstance(value, dict):
316                result[attr] = dict(map(
317                    lambda item: (item[0], item[1].to_dict())
318                    if hasattr(item[1], "to_dict") else item,
319                    value.items()
320                ))
321            else:
322                result[attr] = value
323
324        return result
325
326    def to_str(self):
327        """
328        Returns the string representation of the model
329        """
330        return pformat(self.to_dict())
331
332    def __repr__(self):
333        """
334        For `print` and `pprint`
335        """
336        return self.to_str()
337
338    def __eq__(self, other):
339        """
340        Returns true if both objects are equal
341        """
342        return self.__dict__ == other.__dict__
343
344    def __ne__(self, other):
345        """
346        Returns true if both objects are not equal
347        """
348        return not self == other

class DisplayApplianceDocumentPage: View Source

 20class DisplayApplianceDocumentPage(object):
 21    """
 22    NOTE: This class is auto generated by the swagger code generator program.
 23    Do not edit the class manually.
 24    """
 25    def __init__(self, doc_page_count_total=None, document_id=None, document_name=None, extension=None, height72_dpi=None, is_attachment_type=None, page=None, page_id=None, type=None, width72_dpi=None):
 26        """
 27        DisplayApplianceDocumentPage - a model defined in Swagger
 28
 29        :param dict swaggerTypes: The key is attribute name
 30                                  and the value is attribute type.
 31        :param dict attributeMap: The key is attribute name
 32                                  and the value is json key in definition.
 33        """
 34        self.swagger_types = {
 35            'doc_page_count_total': 'int',
 36            'document_id': 'str',
 37            'document_name': 'str',
 38            'extension': 'str',
 39            'height72_dpi': 'int',
 40            'is_attachment_type': 'bool',
 41            'page': 'int',
 42            'page_id': 'str',
 43            'type': 'str',
 44            'width72_dpi': 'int'
 45        }
 46
 47        self.attribute_map = {
 48            'doc_page_count_total': 'docPageCountTotal',
 49            'document_id': 'documentId',
 50            'document_name': 'documentName',
 51            'extension': 'extension',
 52            'height72_dpi': 'height72DPI',
 53            'is_attachment_type': 'isAttachmentType',
 54            'page': 'page',
 55            'page_id': 'pageId',
 56            'type': 'type',
 57            'width72_dpi': 'width72DPI'
 58        }
 59
 60        self._doc_page_count_total = doc_page_count_total
 61        self._document_id = document_id
 62        self._document_name = document_name
 63        self._extension = extension
 64        self._height72_dpi = height72_dpi
 65        self._is_attachment_type = is_attachment_type
 66        self._page = page
 67        self._page_id = page_id
 68        self._type = type
 69        self._width72_dpi = width72_dpi
 70
 71    @property
 72    def doc_page_count_total(self):
 73        """
 74        Gets the doc_page_count_total of this DisplayApplianceDocumentPage.
 75        
 76
 77        :return: The doc_page_count_total of this DisplayApplianceDocumentPage.
 78        :rtype: int
 79        """
 80        return self._doc_page_count_total
 81
 82    @doc_page_count_total.setter
 83    def doc_page_count_total(self, doc_page_count_total):
 84        """
 85        Sets the doc_page_count_total of this DisplayApplianceDocumentPage.
 86        
 87
 88        :param doc_page_count_total: The doc_page_count_total of this DisplayApplianceDocumentPage.
 89        :type: int
 90        """
 91
 92        self._doc_page_count_total = doc_page_count_total
 93
 94    @property
 95    def document_id(self):
 96        """
 97        Gets the document_id of this DisplayApplianceDocumentPage.
 98        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
 99
100        :return: The document_id of this DisplayApplianceDocumentPage.
101        :rtype: str
102        """
103        return self._document_id
104
105    @document_id.setter
106    def document_id(self, document_id):
107        """
108        Sets the document_id of this DisplayApplianceDocumentPage.
109        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
110
111        :param document_id: The document_id of this DisplayApplianceDocumentPage.
112        :type: str
113        """
114
115        self._document_id = document_id
116
117    @property
118    def document_name(self):
119        """
120        Gets the document_name of this DisplayApplianceDocumentPage.
121        
122
123        :return: The document_name of this DisplayApplianceDocumentPage.
124        :rtype: str
125        """
126        return self._document_name
127
128    @document_name.setter
129    def document_name(self, document_name):
130        """
131        Sets the document_name of this DisplayApplianceDocumentPage.
132        
133
134        :param document_name: The document_name of this DisplayApplianceDocumentPage.
135        :type: str
136        """
137
138        self._document_name = document_name
139
140    @property
141    def extension(self):
142        """
143        Gets the extension of this DisplayApplianceDocumentPage.
144        
145
146        :return: The extension of this DisplayApplianceDocumentPage.
147        :rtype: str
148        """
149        return self._extension
150
151    @extension.setter
152    def extension(self, extension):
153        """
154        Sets the extension of this DisplayApplianceDocumentPage.
155        
156
157        :param extension: The extension of this DisplayApplianceDocumentPage.
158        :type: str
159        """
160
161        self._extension = extension
162
163    @property
164    def height72_dpi(self):
165        """
166        Gets the height72_dpi of this DisplayApplianceDocumentPage.
167        
168
169        :return: The height72_dpi of this DisplayApplianceDocumentPage.
170        :rtype: int
171        """
172        return self._height72_dpi
173
174    @height72_dpi.setter
175    def height72_dpi(self, height72_dpi):
176        """
177        Sets the height72_dpi of this DisplayApplianceDocumentPage.
178        
179
180        :param height72_dpi: The height72_dpi of this DisplayApplianceDocumentPage.
181        :type: int
182        """
183
184        self._height72_dpi = height72_dpi
185
186    @property
187    def is_attachment_type(self):
188        """
189        Gets the is_attachment_type of this DisplayApplianceDocumentPage.
190        
191
192        :return: The is_attachment_type of this DisplayApplianceDocumentPage.
193        :rtype: bool
194        """
195        return self._is_attachment_type
196
197    @is_attachment_type.setter
198    def is_attachment_type(self, is_attachment_type):
199        """
200        Sets the is_attachment_type of this DisplayApplianceDocumentPage.
201        
202
203        :param is_attachment_type: The is_attachment_type of this DisplayApplianceDocumentPage.
204        :type: bool
205        """
206
207        self._is_attachment_type = is_attachment_type
208
209    @property
210    def page(self):
211        """
212        Gets the page of this DisplayApplianceDocumentPage.
213        
214
215        :return: The page of this DisplayApplianceDocumentPage.
216        :rtype: int
217        """
218        return self._page
219
220    @page.setter
221    def page(self, page):
222        """
223        Sets the page of this DisplayApplianceDocumentPage.
224        
225
226        :param page: The page of this DisplayApplianceDocumentPage.
227        :type: int
228        """
229
230        self._page = page
231
232    @property
233    def page_id(self):
234        """
235        Gets the page_id of this DisplayApplianceDocumentPage.
236        
237
238        :return: The page_id of this DisplayApplianceDocumentPage.
239        :rtype: str
240        """
241        return self._page_id
242
243    @page_id.setter
244    def page_id(self, page_id):
245        """
246        Sets the page_id of this DisplayApplianceDocumentPage.
247        
248
249        :param page_id: The page_id of this DisplayApplianceDocumentPage.
250        :type: str
251        """
252
253        self._page_id = page_id
254
255    @property
256    def type(self):
257        """
258        Gets the type of this DisplayApplianceDocumentPage.
259        
260
261        :return: The type of this DisplayApplianceDocumentPage.
262        :rtype: str
263        """
264        return self._type
265
266    @type.setter
267    def type(self, type):
268        """
269        Sets the type of this DisplayApplianceDocumentPage.
270        
271
272        :param type: The type of this DisplayApplianceDocumentPage.
273        :type: str
274        """
275
276        self._type = type
277
278    @property
279    def width72_dpi(self):
280        """
281        Gets the width72_dpi of this DisplayApplianceDocumentPage.
282        
283
284        :return: The width72_dpi of this DisplayApplianceDocumentPage.
285        :rtype: int
286        """
287        return self._width72_dpi
288
289    @width72_dpi.setter
290    def width72_dpi(self, width72_dpi):
291        """
292        Sets the width72_dpi of this DisplayApplianceDocumentPage.
293        
294
295        :param width72_dpi: The width72_dpi of this DisplayApplianceDocumentPage.
296        :type: int
297        """
298
299        self._width72_dpi = width72_dpi
300
301    def to_dict(self):
302        """
303        Returns the model properties as a dict
304        """
305        result = {}
306
307        for attr, _ in iteritems(self.swagger_types):
308            value = getattr(self, attr)
309            if isinstance(value, list):
310                result[attr] = list(map(
311                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
312                    value
313                ))
314            elif hasattr(value, "to_dict"):
315                result[attr] = value.to_dict()
316            elif isinstance(value, dict):
317                result[attr] = dict(map(
318                    lambda item: (item[0], item[1].to_dict())
319                    if hasattr(item[1], "to_dict") else item,
320                    value.items()
321                ))
322            else:
323                result[attr] = value
324
325        return result
326
327    def to_str(self):
328        """
329        Returns the string representation of the model
330        """
331        return pformat(self.to_dict())
332
333    def __repr__(self):
334        """
335        For `print` and `pprint`
336        """
337        return self.to_str()
338
339    def __eq__(self, other):
340        """
341        Returns true if both objects are equal
342        """
343        return self.__dict__ == other.__dict__
344
345    def __ne__(self, other):
346        """
347        Returns true if both objects are not equal
348        """
349        return not self == other

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

DisplayApplianceDocumentPage( doc_page_count_total=None, document_id=None, document_name=None, extension=None, height72_dpi=None, is_attachment_type=None, page=None, page_id=None, type=None, width72_dpi=None) View Source

25    def __init__(self, doc_page_count_total=None, document_id=None, document_name=None, extension=None, height72_dpi=None, is_attachment_type=None, page=None, page_id=None, type=None, width72_dpi=None):
26        """
27        DisplayApplianceDocumentPage - a model defined in Swagger
28
29        :param dict swaggerTypes: The key is attribute name
30                                  and the value is attribute type.
31        :param dict attributeMap: The key is attribute name
32                                  and the value is json key in definition.
33        """
34        self.swagger_types = {
35            'doc_page_count_total': 'int',
36            'document_id': 'str',
37            'document_name': 'str',
38            'extension': 'str',
39            'height72_dpi': 'int',
40            'is_attachment_type': 'bool',
41            'page': 'int',
42            'page_id': 'str',
43            'type': 'str',
44            'width72_dpi': 'int'
45        }
46
47        self.attribute_map = {
48            'doc_page_count_total': 'docPageCountTotal',
49            'document_id': 'documentId',
50            'document_name': 'documentName',
51            'extension': 'extension',
52            'height72_dpi': 'height72DPI',
53            'is_attachment_type': 'isAttachmentType',
54            'page': 'page',
55            'page_id': 'pageId',
56            'type': 'type',
57            'width72_dpi': 'width72DPI'
58        }
59
60        self._doc_page_count_total = doc_page_count_total
61        self._document_id = document_id
62        self._document_name = document_name
63        self._extension = extension
64        self._height72_dpi = height72_dpi
65        self._is_attachment_type = is_attachment_type
66        self._page = page
67        self._page_id = page_id
68        self._type = type
69        self._width72_dpi = width72_dpi

DisplayApplianceDocumentPage - a model defined in Swagger

Parameters

dict swaggerTypes: The key is attribute name and the value is attribute type.
dict attributeMap: The key is attribute name and the value is json key in definition.

doc_page_count_total

Gets the doc_page_count_total of this DisplayApplianceDocumentPage.

Returns

The doc_page_count_total of this DisplayApplianceDocumentPage.

document_id

Gets the document_id of this DisplayApplianceDocumentPage. Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

Returns

The document_id of this DisplayApplianceDocumentPage.

document_name

Gets the document_name of this DisplayApplianceDocumentPage.

Returns

The document_name of this DisplayApplianceDocumentPage.

extension

Gets the extension of this DisplayApplianceDocumentPage.

Returns

The extension of this DisplayApplianceDocumentPage.

height72_dpi

Gets the height72_dpi of this DisplayApplianceDocumentPage.

Returns

The height72_dpi of this DisplayApplianceDocumentPage.

is_attachment_type

Gets the is_attachment_type of this DisplayApplianceDocumentPage.

Returns

The is_attachment_type of this DisplayApplianceDocumentPage.

page

Gets the page of this DisplayApplianceDocumentPage.

Returns

The page of this DisplayApplianceDocumentPage.

page_id

Gets the page_id of this DisplayApplianceDocumentPage.

Returns

The page_id of this DisplayApplianceDocumentPage.

type

Gets the type of this DisplayApplianceDocumentPage.

Returns

The type of this DisplayApplianceDocumentPage.

width72_dpi

Gets the width72_dpi of this DisplayApplianceDocumentPage.

Returns

The width72_dpi of this DisplayApplianceDocumentPage.

def to_dict(self) View Source

301    def to_dict(self):
302        """
303        Returns the model properties as a dict
304        """
305        result = {}
306
307        for attr, _ in iteritems(self.swagger_types):
308            value = getattr(self, attr)
309            if isinstance(value, list):
310                result[attr] = list(map(
311                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
312                    value
313                ))
314            elif hasattr(value, "to_dict"):
315                result[attr] = value.to_dict()
316            elif isinstance(value, dict):
317                result[attr] = dict(map(
318                    lambda item: (item[0], item[1].to_dict())
319                    if hasattr(item[1], "to_dict") else item,
320                    value.items()
321                ))
322            else:
323                result[attr] = value
324
325        return result

Returns the model properties as a dict

def to_str(self) View Source

327    def to_str(self):
328        """
329        Returns the string representation of the model
330        """
331        return pformat(self.to_dict())

Returns the string representation of the model