docusign_esign.models.display_appliance_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 DisplayAppliancePage(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_name=None, document_id=None, external_document_id=None, height=None, is_first_page=None, page_id=None, page_no=None, page_status=None, page_type=None, width=None):
 25        """
 26        DisplayAppliancePage - 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_name': 'str',
 35            'document_id': 'str',
 36            'external_document_id': 'str',
 37            'height': 'int',
 38            'is_first_page': 'bool',
 39            'page_id': 'str',
 40            'page_no': 'int',
 41            'page_status': 'str',
 42            'page_type': 'str',
 43            'width': 'int'
 44        }
 45
 46        self.attribute_map = {
 47            'doc_name': 'docName',
 48            'document_id': 'documentId',
 49            'external_document_id': 'externalDocumentId',
 50            'height': 'height',
 51            'is_first_page': 'isFirstPage',
 52            'page_id': 'pageId',
 53            'page_no': 'pageNo',
 54            'page_status': 'pageStatus',
 55            'page_type': 'pageType',
 56            'width': 'width'
 57        }
 58
 59        self._doc_name = doc_name
 60        self._document_id = document_id
 61        self._external_document_id = external_document_id
 62        self._height = height
 63        self._is_first_page = is_first_page
 64        self._page_id = page_id
 65        self._page_no = page_no
 66        self._page_status = page_status
 67        self._page_type = page_type
 68        self._width = width
 69
 70    @property
 71    def doc_name(self):
 72        """
 73        Gets the doc_name of this DisplayAppliancePage.
 74        
 75
 76        :return: The doc_name of this DisplayAppliancePage.
 77        :rtype: str
 78        """
 79        return self._doc_name
 80
 81    @doc_name.setter
 82    def doc_name(self, doc_name):
 83        """
 84        Sets the doc_name of this DisplayAppliancePage.
 85        
 86
 87        :param doc_name: The doc_name of this DisplayAppliancePage.
 88        :type: str
 89        """
 90
 91        self._doc_name = doc_name
 92
 93    @property
 94    def document_id(self):
 95        """
 96        Gets the document_id of this DisplayAppliancePage.
 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 DisplayAppliancePage.
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 DisplayAppliancePage.
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 DisplayAppliancePage.
111        :type: str
112        """
113
114        self._document_id = document_id
115
116    @property
117    def external_document_id(self):
118        """
119        Gets the external_document_id of this DisplayAppliancePage.
120        
121
122        :return: The external_document_id of this DisplayAppliancePage.
123        :rtype: str
124        """
125        return self._external_document_id
126
127    @external_document_id.setter
128    def external_document_id(self, external_document_id):
129        """
130        Sets the external_document_id of this DisplayAppliancePage.
131        
132
133        :param external_document_id: The external_document_id of this DisplayAppliancePage.
134        :type: str
135        """
136
137        self._external_document_id = external_document_id
138
139    @property
140    def height(self):
141        """
142        Gets the height of this DisplayAppliancePage.
143        Height of the tab in pixels.
144
145        :return: The height of this DisplayAppliancePage.
146        :rtype: int
147        """
148        return self._height
149
150    @height.setter
151    def height(self, height):
152        """
153        Sets the height of this DisplayAppliancePage.
154        Height of the tab in pixels.
155
156        :param height: The height of this DisplayAppliancePage.
157        :type: int
158        """
159
160        self._height = height
161
162    @property
163    def is_first_page(self):
164        """
165        Gets the is_first_page of this DisplayAppliancePage.
166        
167
168        :return: The is_first_page of this DisplayAppliancePage.
169        :rtype: bool
170        """
171        return self._is_first_page
172
173    @is_first_page.setter
174    def is_first_page(self, is_first_page):
175        """
176        Sets the is_first_page of this DisplayAppliancePage.
177        
178
179        :param is_first_page: The is_first_page of this DisplayAppliancePage.
180        :type: bool
181        """
182
183        self._is_first_page = is_first_page
184
185    @property
186    def page_id(self):
187        """
188        Gets the page_id of this DisplayAppliancePage.
189        
190
191        :return: The page_id of this DisplayAppliancePage.
192        :rtype: str
193        """
194        return self._page_id
195
196    @page_id.setter
197    def page_id(self, page_id):
198        """
199        Sets the page_id of this DisplayAppliancePage.
200        
201
202        :param page_id: The page_id of this DisplayAppliancePage.
203        :type: str
204        """
205
206        self._page_id = page_id
207
208    @property
209    def page_no(self):
210        """
211        Gets the page_no of this DisplayAppliancePage.
212        
213
214        :return: The page_no of this DisplayAppliancePage.
215        :rtype: int
216        """
217        return self._page_no
218
219    @page_no.setter
220    def page_no(self, page_no):
221        """
222        Sets the page_no of this DisplayAppliancePage.
223        
224
225        :param page_no: The page_no of this DisplayAppliancePage.
226        :type: int
227        """
228
229        self._page_no = page_no
230
231    @property
232    def page_status(self):
233        """
234        Gets the page_status of this DisplayAppliancePage.
235        
236
237        :return: The page_status of this DisplayAppliancePage.
238        :rtype: str
239        """
240        return self._page_status
241
242    @page_status.setter
243    def page_status(self, page_status):
244        """
245        Sets the page_status of this DisplayAppliancePage.
246        
247
248        :param page_status: The page_status of this DisplayAppliancePage.
249        :type: str
250        """
251
252        self._page_status = page_status
253
254    @property
255    def page_type(self):
256        """
257        Gets the page_type of this DisplayAppliancePage.
258        
259
260        :return: The page_type of this DisplayAppliancePage.
261        :rtype: str
262        """
263        return self._page_type
264
265    @page_type.setter
266    def page_type(self, page_type):
267        """
268        Sets the page_type of this DisplayAppliancePage.
269        
270
271        :param page_type: The page_type of this DisplayAppliancePage.
272        :type: str
273        """
274
275        self._page_type = page_type
276
277    @property
278    def width(self):
279        """
280        Gets the width of this DisplayAppliancePage.
281        Width of the tab in pixels.
282
283        :return: The width of this DisplayAppliancePage.
284        :rtype: int
285        """
286        return self._width
287
288    @width.setter
289    def width(self, width):
290        """
291        Sets the width of this DisplayAppliancePage.
292        Width of the tab in pixels.
293
294        :param width: The width of this DisplayAppliancePage.
295        :type: int
296        """
297
298        self._width = width
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 DisplayAppliancePage: View Source

 20class DisplayAppliancePage(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_name=None, document_id=None, external_document_id=None, height=None, is_first_page=None, page_id=None, page_no=None, page_status=None, page_type=None, width=None):
 26        """
 27        DisplayAppliancePage - 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_name': 'str',
 36            'document_id': 'str',
 37            'external_document_id': 'str',
 38            'height': 'int',
 39            'is_first_page': 'bool',
 40            'page_id': 'str',
 41            'page_no': 'int',
 42            'page_status': 'str',
 43            'page_type': 'str',
 44            'width': 'int'
 45        }
 46
 47        self.attribute_map = {
 48            'doc_name': 'docName',
 49            'document_id': 'documentId',
 50            'external_document_id': 'externalDocumentId',
 51            'height': 'height',
 52            'is_first_page': 'isFirstPage',
 53            'page_id': 'pageId',
 54            'page_no': 'pageNo',
 55            'page_status': 'pageStatus',
 56            'page_type': 'pageType',
 57            'width': 'width'
 58        }
 59
 60        self._doc_name = doc_name
 61        self._document_id = document_id
 62        self._external_document_id = external_document_id
 63        self._height = height
 64        self._is_first_page = is_first_page
 65        self._page_id = page_id
 66        self._page_no = page_no
 67        self._page_status = page_status
 68        self._page_type = page_type
 69        self._width = width
 70
 71    @property
 72    def doc_name(self):
 73        """
 74        Gets the doc_name of this DisplayAppliancePage.
 75        
 76
 77        :return: The doc_name of this DisplayAppliancePage.
 78        :rtype: str
 79        """
 80        return self._doc_name
 81
 82    @doc_name.setter
 83    def doc_name(self, doc_name):
 84        """
 85        Sets the doc_name of this DisplayAppliancePage.
 86        
 87
 88        :param doc_name: The doc_name of this DisplayAppliancePage.
 89        :type: str
 90        """
 91
 92        self._doc_name = doc_name
 93
 94    @property
 95    def document_id(self):
 96        """
 97        Gets the document_id of this DisplayAppliancePage.
 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 DisplayAppliancePage.
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 DisplayAppliancePage.
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 DisplayAppliancePage.
112        :type: str
113        """
114
115        self._document_id = document_id
116
117    @property
118    def external_document_id(self):
119        """
120        Gets the external_document_id of this DisplayAppliancePage.
121        
122
123        :return: The external_document_id of this DisplayAppliancePage.
124        :rtype: str
125        """
126        return self._external_document_id
127
128    @external_document_id.setter
129    def external_document_id(self, external_document_id):
130        """
131        Sets the external_document_id of this DisplayAppliancePage.
132        
133
134        :param external_document_id: The external_document_id of this DisplayAppliancePage.
135        :type: str
136        """
137
138        self._external_document_id = external_document_id
139
140    @property
141    def height(self):
142        """
143        Gets the height of this DisplayAppliancePage.
144        Height of the tab in pixels.
145
146        :return: The height of this DisplayAppliancePage.
147        :rtype: int
148        """
149        return self._height
150
151    @height.setter
152    def height(self, height):
153        """
154        Sets the height of this DisplayAppliancePage.
155        Height of the tab in pixels.
156
157        :param height: The height of this DisplayAppliancePage.
158        :type: int
159        """
160
161        self._height = height
162
163    @property
164    def is_first_page(self):
165        """
166        Gets the is_first_page of this DisplayAppliancePage.
167        
168
169        :return: The is_first_page of this DisplayAppliancePage.
170        :rtype: bool
171        """
172        return self._is_first_page
173
174    @is_first_page.setter
175    def is_first_page(self, is_first_page):
176        """
177        Sets the is_first_page of this DisplayAppliancePage.
178        
179
180        :param is_first_page: The is_first_page of this DisplayAppliancePage.
181        :type: bool
182        """
183
184        self._is_first_page = is_first_page
185
186    @property
187    def page_id(self):
188        """
189        Gets the page_id of this DisplayAppliancePage.
190        
191
192        :return: The page_id of this DisplayAppliancePage.
193        :rtype: str
194        """
195        return self._page_id
196
197    @page_id.setter
198    def page_id(self, page_id):
199        """
200        Sets the page_id of this DisplayAppliancePage.
201        
202
203        :param page_id: The page_id of this DisplayAppliancePage.
204        :type: str
205        """
206
207        self._page_id = page_id
208
209    @property
210    def page_no(self):
211        """
212        Gets the page_no of this DisplayAppliancePage.
213        
214
215        :return: The page_no of this DisplayAppliancePage.
216        :rtype: int
217        """
218        return self._page_no
219
220    @page_no.setter
221    def page_no(self, page_no):
222        """
223        Sets the page_no of this DisplayAppliancePage.
224        
225
226        :param page_no: The page_no of this DisplayAppliancePage.
227        :type: int
228        """
229
230        self._page_no = page_no
231
232    @property
233    def page_status(self):
234        """
235        Gets the page_status of this DisplayAppliancePage.
236        
237
238        :return: The page_status of this DisplayAppliancePage.
239        :rtype: str
240        """
241        return self._page_status
242
243    @page_status.setter
244    def page_status(self, page_status):
245        """
246        Sets the page_status of this DisplayAppliancePage.
247        
248
249        :param page_status: The page_status of this DisplayAppliancePage.
250        :type: str
251        """
252
253        self._page_status = page_status
254
255    @property
256    def page_type(self):
257        """
258        Gets the page_type of this DisplayAppliancePage.
259        
260
261        :return: The page_type of this DisplayAppliancePage.
262        :rtype: str
263        """
264        return self._page_type
265
266    @page_type.setter
267    def page_type(self, page_type):
268        """
269        Sets the page_type of this DisplayAppliancePage.
270        
271
272        :param page_type: The page_type of this DisplayAppliancePage.
273        :type: str
274        """
275
276        self._page_type = page_type
277
278    @property
279    def width(self):
280        """
281        Gets the width of this DisplayAppliancePage.
282        Width of the tab in pixels.
283
284        :return: The width of this DisplayAppliancePage.
285        :rtype: int
286        """
287        return self._width
288
289    @width.setter
290    def width(self, width):
291        """
292        Sets the width of this DisplayAppliancePage.
293        Width of the tab in pixels.
294
295        :param width: The width of this DisplayAppliancePage.
296        :type: int
297        """
298
299        self._width = width
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.

DisplayAppliancePage( doc_name=None, document_id=None, external_document_id=None, height=None, is_first_page=None, page_id=None, page_no=None, page_status=None, page_type=None, width=None) View Source

25    def __init__(self, doc_name=None, document_id=None, external_document_id=None, height=None, is_first_page=None, page_id=None, page_no=None, page_status=None, page_type=None, width=None):
26        """
27        DisplayAppliancePage - 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_name': 'str',
36            'document_id': 'str',
37            'external_document_id': 'str',
38            'height': 'int',
39            'is_first_page': 'bool',
40            'page_id': 'str',
41            'page_no': 'int',
42            'page_status': 'str',
43            'page_type': 'str',
44            'width': 'int'
45        }
46
47        self.attribute_map = {
48            'doc_name': 'docName',
49            'document_id': 'documentId',
50            'external_document_id': 'externalDocumentId',
51            'height': 'height',
52            'is_first_page': 'isFirstPage',
53            'page_id': 'pageId',
54            'page_no': 'pageNo',
55            'page_status': 'pageStatus',
56            'page_type': 'pageType',
57            'width': 'width'
58        }
59
60        self._doc_name = doc_name
61        self._document_id = document_id
62        self._external_document_id = external_document_id
63        self._height = height
64        self._is_first_page = is_first_page
65        self._page_id = page_id
66        self._page_no = page_no
67        self._page_status = page_status
68        self._page_type = page_type
69        self._width = width

DisplayAppliancePage - 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_name

Gets the doc_name of this DisplayAppliancePage.

Returns

The doc_name of this DisplayAppliancePage.

document_id

Gets the document_id of this DisplayAppliancePage. 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 DisplayAppliancePage.

external_document_id

Gets the external_document_id of this DisplayAppliancePage.

Returns

The external_document_id of this DisplayAppliancePage.

height

Gets the height of this DisplayAppliancePage. Height of the tab in pixels.

Returns

The height of this DisplayAppliancePage.

is_first_page

Gets the is_first_page of this DisplayAppliancePage.

Returns

The is_first_page of this DisplayAppliancePage.

page_id

Gets the page_id of this DisplayAppliancePage.

Returns

The page_id of this DisplayAppliancePage.

page_no

Gets the page_no of this DisplayAppliancePage.

Returns

The page_no of this DisplayAppliancePage.

page_status

Gets the page_status of this DisplayAppliancePage.

Returns

The page_status of this DisplayAppliancePage.

page_type

Gets the page_type of this DisplayAppliancePage.

Returns

The page_type of this DisplayAppliancePage.

width

Gets the width of this DisplayAppliancePage. Width of the tab in pixels.

Returns

The width of this DisplayAppliancePage.

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