docusign_esign.models.display_appliance_document

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

  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 DisplayApplianceDocument(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, attachment_date=None, attachment_description=None, copy_pdf_id=None, document_id=None, document_type=None, envelope_id=None, external_document_id=None, latest_pdf_id=None, name=None, original_pdf_id=None, pages=None, row_state=None, sequence=None, status=None):
 25        """
 26        DisplayApplianceDocument - 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            'attachment_date': 'str',
 35            'attachment_description': 'str',
 36            'copy_pdf_id': 'str',
 37            'document_id': 'str',
 38            'document_type': 'str',
 39            'envelope_id': 'str',
 40            'external_document_id': 'str',
 41            'latest_pdf_id': 'str',
 42            'name': 'str',
 43            'original_pdf_id': 'str',
 44            'pages': 'str',
 45            'row_state': 'str',
 46            'sequence': 'str',
 47            'status': 'str'
 48        }
 49
 50        self.attribute_map = {
 51            'attachment_date': 'attachmentDate',
 52            'attachment_description': 'attachmentDescription',
 53            'copy_pdf_id': 'copyPDFId',
 54            'document_id': 'documentId',
 55            'document_type': 'documentType',
 56            'envelope_id': 'envelopeId',
 57            'external_document_id': 'externalDocumentId',
 58            'latest_pdf_id': 'latestPDFId',
 59            'name': 'name',
 60            'original_pdf_id': 'originalPDFId',
 61            'pages': 'pages',
 62            'row_state': 'rowState',
 63            'sequence': 'sequence',
 64            'status': 'status'
 65        }
 66
 67        self._attachment_date = attachment_date
 68        self._attachment_description = attachment_description
 69        self._copy_pdf_id = copy_pdf_id
 70        self._document_id = document_id
 71        self._document_type = document_type
 72        self._envelope_id = envelope_id
 73        self._external_document_id = external_document_id
 74        self._latest_pdf_id = latest_pdf_id
 75        self._name = name
 76        self._original_pdf_id = original_pdf_id
 77        self._pages = pages
 78        self._row_state = row_state
 79        self._sequence = sequence
 80        self._status = status
 81
 82    @property
 83    def attachment_date(self):
 84        """
 85        Gets the attachment_date of this DisplayApplianceDocument.
 86        
 87
 88        :return: The attachment_date of this DisplayApplianceDocument.
 89        :rtype: str
 90        """
 91        return self._attachment_date
 92
 93    @attachment_date.setter
 94    def attachment_date(self, attachment_date):
 95        """
 96        Sets the attachment_date of this DisplayApplianceDocument.
 97        
 98
 99        :param attachment_date: The attachment_date of this DisplayApplianceDocument.
100        :type: str
101        """
102
103        self._attachment_date = attachment_date
104
105    @property
106    def attachment_description(self):
107        """
108        Gets the attachment_description of this DisplayApplianceDocument.
109        
110
111        :return: The attachment_description of this DisplayApplianceDocument.
112        :rtype: str
113        """
114        return self._attachment_description
115
116    @attachment_description.setter
117    def attachment_description(self, attachment_description):
118        """
119        Sets the attachment_description of this DisplayApplianceDocument.
120        
121
122        :param attachment_description: The attachment_description of this DisplayApplianceDocument.
123        :type: str
124        """
125
126        self._attachment_description = attachment_description
127
128    @property
129    def copy_pdf_id(self):
130        """
131        Gets the copy_pdf_id of this DisplayApplianceDocument.
132        
133
134        :return: The copy_pdf_id of this DisplayApplianceDocument.
135        :rtype: str
136        """
137        return self._copy_pdf_id
138
139    @copy_pdf_id.setter
140    def copy_pdf_id(self, copy_pdf_id):
141        """
142        Sets the copy_pdf_id of this DisplayApplianceDocument.
143        
144
145        :param copy_pdf_id: The copy_pdf_id of this DisplayApplianceDocument.
146        :type: str
147        """
148
149        self._copy_pdf_id = copy_pdf_id
150
151    @property
152    def document_id(self):
153        """
154        Gets the document_id of this DisplayApplianceDocument.
155        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
156
157        :return: The document_id of this DisplayApplianceDocument.
158        :rtype: str
159        """
160        return self._document_id
161
162    @document_id.setter
163    def document_id(self, document_id):
164        """
165        Sets the document_id of this DisplayApplianceDocument.
166        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
167
168        :param document_id: The document_id of this DisplayApplianceDocument.
169        :type: str
170        """
171
172        self._document_id = document_id
173
174    @property
175    def document_type(self):
176        """
177        Gets the document_type of this DisplayApplianceDocument.
178        
179
180        :return: The document_type of this DisplayApplianceDocument.
181        :rtype: str
182        """
183        return self._document_type
184
185    @document_type.setter
186    def document_type(self, document_type):
187        """
188        Sets the document_type of this DisplayApplianceDocument.
189        
190
191        :param document_type: The document_type of this DisplayApplianceDocument.
192        :type: str
193        """
194
195        self._document_type = document_type
196
197    @property
198    def envelope_id(self):
199        """
200        Gets the envelope_id of this DisplayApplianceDocument.
201        The envelope ID of the envelope status that failed to post.
202
203        :return: The envelope_id of this DisplayApplianceDocument.
204        :rtype: str
205        """
206        return self._envelope_id
207
208    @envelope_id.setter
209    def envelope_id(self, envelope_id):
210        """
211        Sets the envelope_id of this DisplayApplianceDocument.
212        The envelope ID of the envelope status that failed to post.
213
214        :param envelope_id: The envelope_id of this DisplayApplianceDocument.
215        :type: str
216        """
217
218        self._envelope_id = envelope_id
219
220    @property
221    def external_document_id(self):
222        """
223        Gets the external_document_id of this DisplayApplianceDocument.
224        
225
226        :return: The external_document_id of this DisplayApplianceDocument.
227        :rtype: str
228        """
229        return self._external_document_id
230
231    @external_document_id.setter
232    def external_document_id(self, external_document_id):
233        """
234        Sets the external_document_id of this DisplayApplianceDocument.
235        
236
237        :param external_document_id: The external_document_id of this DisplayApplianceDocument.
238        :type: str
239        """
240
241        self._external_document_id = external_document_id
242
243    @property
244    def latest_pdf_id(self):
245        """
246        Gets the latest_pdf_id of this DisplayApplianceDocument.
247        
248
249        :return: The latest_pdf_id of this DisplayApplianceDocument.
250        :rtype: str
251        """
252        return self._latest_pdf_id
253
254    @latest_pdf_id.setter
255    def latest_pdf_id(self, latest_pdf_id):
256        """
257        Sets the latest_pdf_id of this DisplayApplianceDocument.
258        
259
260        :param latest_pdf_id: The latest_pdf_id of this DisplayApplianceDocument.
261        :type: str
262        """
263
264        self._latest_pdf_id = latest_pdf_id
265
266    @property
267    def name(self):
268        """
269        Gets the name of this DisplayApplianceDocument.
270        
271
272        :return: The name of this DisplayApplianceDocument.
273        :rtype: str
274        """
275        return self._name
276
277    @name.setter
278    def name(self, name):
279        """
280        Sets the name of this DisplayApplianceDocument.
281        
282
283        :param name: The name of this DisplayApplianceDocument.
284        :type: str
285        """
286
287        self._name = name
288
289    @property
290    def original_pdf_id(self):
291        """
292        Gets the original_pdf_id of this DisplayApplianceDocument.
293        
294
295        :return: The original_pdf_id of this DisplayApplianceDocument.
296        :rtype: str
297        """
298        return self._original_pdf_id
299
300    @original_pdf_id.setter
301    def original_pdf_id(self, original_pdf_id):
302        """
303        Sets the original_pdf_id of this DisplayApplianceDocument.
304        
305
306        :param original_pdf_id: The original_pdf_id of this DisplayApplianceDocument.
307        :type: str
308        """
309
310        self._original_pdf_id = original_pdf_id
311
312    @property
313    def pages(self):
314        """
315        Gets the pages of this DisplayApplianceDocument.
316        
317
318        :return: The pages of this DisplayApplianceDocument.
319        :rtype: str
320        """
321        return self._pages
322
323    @pages.setter
324    def pages(self, pages):
325        """
326        Sets the pages of this DisplayApplianceDocument.
327        
328
329        :param pages: The pages of this DisplayApplianceDocument.
330        :type: str
331        """
332
333        self._pages = pages
334
335    @property
336    def row_state(self):
337        """
338        Gets the row_state of this DisplayApplianceDocument.
339        
340
341        :return: The row_state of this DisplayApplianceDocument.
342        :rtype: str
343        """
344        return self._row_state
345
346    @row_state.setter
347    def row_state(self, row_state):
348        """
349        Sets the row_state of this DisplayApplianceDocument.
350        
351
352        :param row_state: The row_state of this DisplayApplianceDocument.
353        :type: str
354        """
355
356        self._row_state = row_state
357
358    @property
359    def sequence(self):
360        """
361        Gets the sequence of this DisplayApplianceDocument.
362        
363
364        :return: The sequence of this DisplayApplianceDocument.
365        :rtype: str
366        """
367        return self._sequence
368
369    @sequence.setter
370    def sequence(self, sequence):
371        """
372        Sets the sequence of this DisplayApplianceDocument.
373        
374
375        :param sequence: The sequence of this DisplayApplianceDocument.
376        :type: str
377        """
378
379        self._sequence = sequence
380
381    @property
382    def status(self):
383        """
384        Gets the status of this DisplayApplianceDocument.
385        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.
386
387        :return: The status of this DisplayApplianceDocument.
388        :rtype: str
389        """
390        return self._status
391
392    @status.setter
393    def status(self, status):
394        """
395        Sets the status of this DisplayApplianceDocument.
396        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.
397
398        :param status: The status of this DisplayApplianceDocument.
399        :type: str
400        """
401
402        self._status = status
403
404    def to_dict(self):
405        """
406        Returns the model properties as a dict
407        """
408        result = {}
409
410        for attr, _ in iteritems(self.swagger_types):
411            value = getattr(self, attr)
412            if isinstance(value, list):
413                result[attr] = list(map(
414                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
415                    value
416                ))
417            elif hasattr(value, "to_dict"):
418                result[attr] = value.to_dict()
419            elif isinstance(value, dict):
420                result[attr] = dict(map(
421                    lambda item: (item[0], item[1].to_dict())
422                    if hasattr(item[1], "to_dict") else item,
423                    value.items()
424                ))
425            else:
426                result[attr] = value
427
428        return result
429
430    def to_str(self):
431        """
432        Returns the string representation of the model
433        """
434        return pformat(self.to_dict())
435
436    def __repr__(self):
437        """
438        For `print` and `pprint`
439        """
440        return self.to_str()
441
442    def __eq__(self, other):
443        """
444        Returns true if both objects are equal
445        """
446        return self.__dict__ == other.__dict__
447
448    def __ne__(self, other):
449        """
450        Returns true if both objects are not equal
451        """
452        return not self == other
class DisplayApplianceDocument:
 20class DisplayApplianceDocument(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, attachment_date=None, attachment_description=None, copy_pdf_id=None, document_id=None, document_type=None, envelope_id=None, external_document_id=None, latest_pdf_id=None, name=None, original_pdf_id=None, pages=None, row_state=None, sequence=None, status=None):
 26        """
 27        DisplayApplianceDocument - 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            'attachment_date': 'str',
 36            'attachment_description': 'str',
 37            'copy_pdf_id': 'str',
 38            'document_id': 'str',
 39            'document_type': 'str',
 40            'envelope_id': 'str',
 41            'external_document_id': 'str',
 42            'latest_pdf_id': 'str',
 43            'name': 'str',
 44            'original_pdf_id': 'str',
 45            'pages': 'str',
 46            'row_state': 'str',
 47            'sequence': 'str',
 48            'status': 'str'
 49        }
 50
 51        self.attribute_map = {
 52            'attachment_date': 'attachmentDate',
 53            'attachment_description': 'attachmentDescription',
 54            'copy_pdf_id': 'copyPDFId',
 55            'document_id': 'documentId',
 56            'document_type': 'documentType',
 57            'envelope_id': 'envelopeId',
 58            'external_document_id': 'externalDocumentId',
 59            'latest_pdf_id': 'latestPDFId',
 60            'name': 'name',
 61            'original_pdf_id': 'originalPDFId',
 62            'pages': 'pages',
 63            'row_state': 'rowState',
 64            'sequence': 'sequence',
 65            'status': 'status'
 66        }
 67
 68        self._attachment_date = attachment_date
 69        self._attachment_description = attachment_description
 70        self._copy_pdf_id = copy_pdf_id
 71        self._document_id = document_id
 72        self._document_type = document_type
 73        self._envelope_id = envelope_id
 74        self._external_document_id = external_document_id
 75        self._latest_pdf_id = latest_pdf_id
 76        self._name = name
 77        self._original_pdf_id = original_pdf_id
 78        self._pages = pages
 79        self._row_state = row_state
 80        self._sequence = sequence
 81        self._status = status
 82
 83    @property
 84    def attachment_date(self):
 85        """
 86        Gets the attachment_date of this DisplayApplianceDocument.
 87        
 88
 89        :return: The attachment_date of this DisplayApplianceDocument.
 90        :rtype: str
 91        """
 92        return self._attachment_date
 93
 94    @attachment_date.setter
 95    def attachment_date(self, attachment_date):
 96        """
 97        Sets the attachment_date of this DisplayApplianceDocument.
 98        
 99
100        :param attachment_date: The attachment_date of this DisplayApplianceDocument.
101        :type: str
102        """
103
104        self._attachment_date = attachment_date
105
106    @property
107    def attachment_description(self):
108        """
109        Gets the attachment_description of this DisplayApplianceDocument.
110        
111
112        :return: The attachment_description of this DisplayApplianceDocument.
113        :rtype: str
114        """
115        return self._attachment_description
116
117    @attachment_description.setter
118    def attachment_description(self, attachment_description):
119        """
120        Sets the attachment_description of this DisplayApplianceDocument.
121        
122
123        :param attachment_description: The attachment_description of this DisplayApplianceDocument.
124        :type: str
125        """
126
127        self._attachment_description = attachment_description
128
129    @property
130    def copy_pdf_id(self):
131        """
132        Gets the copy_pdf_id of this DisplayApplianceDocument.
133        
134
135        :return: The copy_pdf_id of this DisplayApplianceDocument.
136        :rtype: str
137        """
138        return self._copy_pdf_id
139
140    @copy_pdf_id.setter
141    def copy_pdf_id(self, copy_pdf_id):
142        """
143        Sets the copy_pdf_id of this DisplayApplianceDocument.
144        
145
146        :param copy_pdf_id: The copy_pdf_id of this DisplayApplianceDocument.
147        :type: str
148        """
149
150        self._copy_pdf_id = copy_pdf_id
151
152    @property
153    def document_id(self):
154        """
155        Gets the document_id of this DisplayApplianceDocument.
156        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
157
158        :return: The document_id of this DisplayApplianceDocument.
159        :rtype: str
160        """
161        return self._document_id
162
163    @document_id.setter
164    def document_id(self, document_id):
165        """
166        Sets the document_id of this DisplayApplianceDocument.
167        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
168
169        :param document_id: The document_id of this DisplayApplianceDocument.
170        :type: str
171        """
172
173        self._document_id = document_id
174
175    @property
176    def document_type(self):
177        """
178        Gets the document_type of this DisplayApplianceDocument.
179        
180
181        :return: The document_type of this DisplayApplianceDocument.
182        :rtype: str
183        """
184        return self._document_type
185
186    @document_type.setter
187    def document_type(self, document_type):
188        """
189        Sets the document_type of this DisplayApplianceDocument.
190        
191
192        :param document_type: The document_type of this DisplayApplianceDocument.
193        :type: str
194        """
195
196        self._document_type = document_type
197
198    @property
199    def envelope_id(self):
200        """
201        Gets the envelope_id of this DisplayApplianceDocument.
202        The envelope ID of the envelope status that failed to post.
203
204        :return: The envelope_id of this DisplayApplianceDocument.
205        :rtype: str
206        """
207        return self._envelope_id
208
209    @envelope_id.setter
210    def envelope_id(self, envelope_id):
211        """
212        Sets the envelope_id of this DisplayApplianceDocument.
213        The envelope ID of the envelope status that failed to post.
214
215        :param envelope_id: The envelope_id of this DisplayApplianceDocument.
216        :type: str
217        """
218
219        self._envelope_id = envelope_id
220
221    @property
222    def external_document_id(self):
223        """
224        Gets the external_document_id of this DisplayApplianceDocument.
225        
226
227        :return: The external_document_id of this DisplayApplianceDocument.
228        :rtype: str
229        """
230        return self._external_document_id
231
232    @external_document_id.setter
233    def external_document_id(self, external_document_id):
234        """
235        Sets the external_document_id of this DisplayApplianceDocument.
236        
237
238        :param external_document_id: The external_document_id of this DisplayApplianceDocument.
239        :type: str
240        """
241
242        self._external_document_id = external_document_id
243
244    @property
245    def latest_pdf_id(self):
246        """
247        Gets the latest_pdf_id of this DisplayApplianceDocument.
248        
249
250        :return: The latest_pdf_id of this DisplayApplianceDocument.
251        :rtype: str
252        """
253        return self._latest_pdf_id
254
255    @latest_pdf_id.setter
256    def latest_pdf_id(self, latest_pdf_id):
257        """
258        Sets the latest_pdf_id of this DisplayApplianceDocument.
259        
260
261        :param latest_pdf_id: The latest_pdf_id of this DisplayApplianceDocument.
262        :type: str
263        """
264
265        self._latest_pdf_id = latest_pdf_id
266
267    @property
268    def name(self):
269        """
270        Gets the name of this DisplayApplianceDocument.
271        
272
273        :return: The name of this DisplayApplianceDocument.
274        :rtype: str
275        """
276        return self._name
277
278    @name.setter
279    def name(self, name):
280        """
281        Sets the name of this DisplayApplianceDocument.
282        
283
284        :param name: The name of this DisplayApplianceDocument.
285        :type: str
286        """
287
288        self._name = name
289
290    @property
291    def original_pdf_id(self):
292        """
293        Gets the original_pdf_id of this DisplayApplianceDocument.
294        
295
296        :return: The original_pdf_id of this DisplayApplianceDocument.
297        :rtype: str
298        """
299        return self._original_pdf_id
300
301    @original_pdf_id.setter
302    def original_pdf_id(self, original_pdf_id):
303        """
304        Sets the original_pdf_id of this DisplayApplianceDocument.
305        
306
307        :param original_pdf_id: The original_pdf_id of this DisplayApplianceDocument.
308        :type: str
309        """
310
311        self._original_pdf_id = original_pdf_id
312
313    @property
314    def pages(self):
315        """
316        Gets the pages of this DisplayApplianceDocument.
317        
318
319        :return: The pages of this DisplayApplianceDocument.
320        :rtype: str
321        """
322        return self._pages
323
324    @pages.setter
325    def pages(self, pages):
326        """
327        Sets the pages of this DisplayApplianceDocument.
328        
329
330        :param pages: The pages of this DisplayApplianceDocument.
331        :type: str
332        """
333
334        self._pages = pages
335
336    @property
337    def row_state(self):
338        """
339        Gets the row_state of this DisplayApplianceDocument.
340        
341
342        :return: The row_state of this DisplayApplianceDocument.
343        :rtype: str
344        """
345        return self._row_state
346
347    @row_state.setter
348    def row_state(self, row_state):
349        """
350        Sets the row_state of this DisplayApplianceDocument.
351        
352
353        :param row_state: The row_state of this DisplayApplianceDocument.
354        :type: str
355        """
356
357        self._row_state = row_state
358
359    @property
360    def sequence(self):
361        """
362        Gets the sequence of this DisplayApplianceDocument.
363        
364
365        :return: The sequence of this DisplayApplianceDocument.
366        :rtype: str
367        """
368        return self._sequence
369
370    @sequence.setter
371    def sequence(self, sequence):
372        """
373        Sets the sequence of this DisplayApplianceDocument.
374        
375
376        :param sequence: The sequence of this DisplayApplianceDocument.
377        :type: str
378        """
379
380        self._sequence = sequence
381
382    @property
383    def status(self):
384        """
385        Gets the status of this DisplayApplianceDocument.
386        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.
387
388        :return: The status of this DisplayApplianceDocument.
389        :rtype: str
390        """
391        return self._status
392
393    @status.setter
394    def status(self, status):
395        """
396        Sets the status of this DisplayApplianceDocument.
397        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.
398
399        :param status: The status of this DisplayApplianceDocument.
400        :type: str
401        """
402
403        self._status = status
404
405    def to_dict(self):
406        """
407        Returns the model properties as a dict
408        """
409        result = {}
410
411        for attr, _ in iteritems(self.swagger_types):
412            value = getattr(self, attr)
413            if isinstance(value, list):
414                result[attr] = list(map(
415                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
416                    value
417                ))
418            elif hasattr(value, "to_dict"):
419                result[attr] = value.to_dict()
420            elif isinstance(value, dict):
421                result[attr] = dict(map(
422                    lambda item: (item[0], item[1].to_dict())
423                    if hasattr(item[1], "to_dict") else item,
424                    value.items()
425                ))
426            else:
427                result[attr] = value
428
429        return result
430
431    def to_str(self):
432        """
433        Returns the string representation of the model
434        """
435        return pformat(self.to_dict())
436
437    def __repr__(self):
438        """
439        For `print` and `pprint`
440        """
441        return self.to_str()
442
443    def __eq__(self, other):
444        """
445        Returns true if both objects are equal
446        """
447        return self.__dict__ == other.__dict__
448
449    def __ne__(self, other):
450        """
451        Returns true if both objects are not equal
452        """
453        return not self == other

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

DisplayApplianceDocument( attachment_date=None, attachment_description=None, copy_pdf_id=None, document_id=None, document_type=None, envelope_id=None, external_document_id=None, latest_pdf_id=None, name=None, original_pdf_id=None, pages=None, row_state=None, sequence=None, status=None)
25    def __init__(self, attachment_date=None, attachment_description=None, copy_pdf_id=None, document_id=None, document_type=None, envelope_id=None, external_document_id=None, latest_pdf_id=None, name=None, original_pdf_id=None, pages=None, row_state=None, sequence=None, status=None):
26        """
27        DisplayApplianceDocument - 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            'attachment_date': 'str',
36            'attachment_description': 'str',
37            'copy_pdf_id': 'str',
38            'document_id': 'str',
39            'document_type': 'str',
40            'envelope_id': 'str',
41            'external_document_id': 'str',
42            'latest_pdf_id': 'str',
43            'name': 'str',
44            'original_pdf_id': 'str',
45            'pages': 'str',
46            'row_state': 'str',
47            'sequence': 'str',
48            'status': 'str'
49        }
50
51        self.attribute_map = {
52            'attachment_date': 'attachmentDate',
53            'attachment_description': 'attachmentDescription',
54            'copy_pdf_id': 'copyPDFId',
55            'document_id': 'documentId',
56            'document_type': 'documentType',
57            'envelope_id': 'envelopeId',
58            'external_document_id': 'externalDocumentId',
59            'latest_pdf_id': 'latestPDFId',
60            'name': 'name',
61            'original_pdf_id': 'originalPDFId',
62            'pages': 'pages',
63            'row_state': 'rowState',
64            'sequence': 'sequence',
65            'status': 'status'
66        }
67
68        self._attachment_date = attachment_date
69        self._attachment_description = attachment_description
70        self._copy_pdf_id = copy_pdf_id
71        self._document_id = document_id
72        self._document_type = document_type
73        self._envelope_id = envelope_id
74        self._external_document_id = external_document_id
75        self._latest_pdf_id = latest_pdf_id
76        self._name = name
77        self._original_pdf_id = original_pdf_id
78        self._pages = pages
79        self._row_state = row_state
80        self._sequence = sequence
81        self._status = status

DisplayApplianceDocument - 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.
attachment_date

Gets the attachment_date of this DisplayApplianceDocument.

Returns

The attachment_date of this DisplayApplianceDocument.

attachment_description

Gets the attachment_description of this DisplayApplianceDocument.

Returns

The attachment_description of this DisplayApplianceDocument.

copy_pdf_id

Gets the copy_pdf_id of this DisplayApplianceDocument.

Returns

The copy_pdf_id of this DisplayApplianceDocument.

document_id

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

document_type

Gets the document_type of this DisplayApplianceDocument.

Returns

The document_type of this DisplayApplianceDocument.

envelope_id

Gets the envelope_id of this DisplayApplianceDocument. The envelope ID of the envelope status that failed to post.

Returns

The envelope_id of this DisplayApplianceDocument.

external_document_id

Gets the external_document_id of this DisplayApplianceDocument.

Returns

The external_document_id of this DisplayApplianceDocument.

latest_pdf_id

Gets the latest_pdf_id of this DisplayApplianceDocument.

Returns

The latest_pdf_id of this DisplayApplianceDocument.

name

Gets the name of this DisplayApplianceDocument.

Returns

The name of this DisplayApplianceDocument.

original_pdf_id

Gets the original_pdf_id of this DisplayApplianceDocument.

Returns

The original_pdf_id of this DisplayApplianceDocument.

pages

Gets the pages of this DisplayApplianceDocument.

Returns

The pages of this DisplayApplianceDocument.

row_state

Gets the row_state of this DisplayApplianceDocument.

Returns

The row_state of this DisplayApplianceDocument.

sequence

Gets the sequence of this DisplayApplianceDocument.

Returns

The sequence of this DisplayApplianceDocument.

status

Gets the status of this DisplayApplianceDocument. Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

Returns

The status of this DisplayApplianceDocument.

def to_dict(self)
405    def to_dict(self):
406        """
407        Returns the model properties as a dict
408        """
409        result = {}
410
411        for attr, _ in iteritems(self.swagger_types):
412            value = getattr(self, attr)
413            if isinstance(value, list):
414                result[attr] = list(map(
415                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
416                    value
417                ))
418            elif hasattr(value, "to_dict"):
419                result[attr] = value.to_dict()
420            elif isinstance(value, dict):
421                result[attr] = dict(map(
422                    lambda item: (item[0], item[1].to_dict())
423                    if hasattr(item[1], "to_dict") else item,
424                    value.items()
425                ))
426            else:
427                result[attr] = value
428
429        return result

Returns the model properties as a dict

def to_str(self)
431    def to_str(self):
432        """
433        Returns the string representation of the model
434        """
435        return pformat(self.to_dict())

Returns the string representation of the model