docusign_esign.models.envelope_document

  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 EnvelopeDocument(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        'added_recipient_ids': 'list[str]',
 37        'attachment_tab_id': 'str',
 38        'authoritative_copy': 'str',
 39        'authoritative_copy_metadata': 'PropertyMetadata',
 40        'available_document_types': 'list[SignatureType]',
 41        'contains_pdf_form_fields': 'str',
 42        'display': 'str',
 43        'display_metadata': 'PropertyMetadata',
 44        'doc_gen_document_status': 'str',
 45        'doc_gen_errors': 'list[DocGenSyntaxError]',
 46        'doc_gen_form_fields': 'list[DocGenFormField]',
 47        'document_base64': 'str',
 48        'document_fields': 'list[NameValue]',
 49        'document_id': 'str',
 50        'document_id_guid': 'str',
 51        'error_details': 'ErrorDetails',
 52        'include_in_download': 'str',
 53        'include_in_download_metadata': 'PropertyMetadata',
 54        'is_ace_gen_document': 'str',
 55        'is_doc_gen_document': 'str',
 56        'name': 'str',
 57        'name_metadata': 'PropertyMetadata',
 58        'order': 'str',
 59        'pages': 'list[Page]',
 60        'signer_must_acknowledge': 'str',
 61        'signer_must_acknowledge_metadata': 'PropertyMetadata',
 62        'size_bytes': 'str',
 63        'template_locked': 'str',
 64        'template_required': 'str',
 65        'type': 'str',
 66        'uri': 'str'
 67    }
 68
 69    attribute_map = {
 70        'added_recipient_ids': 'addedRecipientIds',
 71        'attachment_tab_id': 'attachmentTabId',
 72        'authoritative_copy': 'authoritativeCopy',
 73        'authoritative_copy_metadata': 'authoritativeCopyMetadata',
 74        'available_document_types': 'availableDocumentTypes',
 75        'contains_pdf_form_fields': 'containsPdfFormFields',
 76        'display': 'display',
 77        'display_metadata': 'displayMetadata',
 78        'doc_gen_document_status': 'docGenDocumentStatus',
 79        'doc_gen_errors': 'docGenErrors',
 80        'doc_gen_form_fields': 'docGenFormFields',
 81        'document_base64': 'documentBase64',
 82        'document_fields': 'documentFields',
 83        'document_id': 'documentId',
 84        'document_id_guid': 'documentIdGuid',
 85        'error_details': 'errorDetails',
 86        'include_in_download': 'includeInDownload',
 87        'include_in_download_metadata': 'includeInDownloadMetadata',
 88        'is_ace_gen_document': 'isAceGenDocument',
 89        'is_doc_gen_document': 'isDocGenDocument',
 90        'name': 'name',
 91        'name_metadata': 'nameMetadata',
 92        'order': 'order',
 93        'pages': 'pages',
 94        'signer_must_acknowledge': 'signerMustAcknowledge',
 95        'signer_must_acknowledge_metadata': 'signerMustAcknowledgeMetadata',
 96        'size_bytes': 'sizeBytes',
 97        'template_locked': 'templateLocked',
 98        'template_required': 'templateRequired',
 99        'type': 'type',
100        'uri': 'uri'
101    }
102
103    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
104        """EnvelopeDocument - a model defined in Swagger"""  # noqa: E501
105        if _configuration is None:
106            _configuration = Configuration()
107        self._configuration = _configuration
108
109        self._added_recipient_ids = None
110        self._attachment_tab_id = None
111        self._authoritative_copy = None
112        self._authoritative_copy_metadata = None
113        self._available_document_types = None
114        self._contains_pdf_form_fields = None
115        self._display = None
116        self._display_metadata = None
117        self._doc_gen_document_status = None
118        self._doc_gen_errors = None
119        self._doc_gen_form_fields = None
120        self._document_base64 = None
121        self._document_fields = None
122        self._document_id = None
123        self._document_id_guid = None
124        self._error_details = None
125        self._include_in_download = None
126        self._include_in_download_metadata = None
127        self._is_ace_gen_document = None
128        self._is_doc_gen_document = None
129        self._name = None
130        self._name_metadata = None
131        self._order = None
132        self._pages = None
133        self._signer_must_acknowledge = None
134        self._signer_must_acknowledge_metadata = None
135        self._size_bytes = None
136        self._template_locked = None
137        self._template_required = None
138        self._type = None
139        self._uri = None
140        self.discriminator = None
141
142        setattr(self, "_{}".format('added_recipient_ids'), kwargs.get('added_recipient_ids', None))
143        setattr(self, "_{}".format('attachment_tab_id'), kwargs.get('attachment_tab_id', None))
144        setattr(self, "_{}".format('authoritative_copy'), kwargs.get('authoritative_copy', None))
145        setattr(self, "_{}".format('authoritative_copy_metadata'), kwargs.get('authoritative_copy_metadata', None))
146        setattr(self, "_{}".format('available_document_types'), kwargs.get('available_document_types', None))
147        setattr(self, "_{}".format('contains_pdf_form_fields'), kwargs.get('contains_pdf_form_fields', None))
148        setattr(self, "_{}".format('display'), kwargs.get('display', None))
149        setattr(self, "_{}".format('display_metadata'), kwargs.get('display_metadata', None))
150        setattr(self, "_{}".format('doc_gen_document_status'), kwargs.get('doc_gen_document_status', None))
151        setattr(self, "_{}".format('doc_gen_errors'), kwargs.get('doc_gen_errors', None))
152        setattr(self, "_{}".format('doc_gen_form_fields'), kwargs.get('doc_gen_form_fields', None))
153        setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None))
154        setattr(self, "_{}".format('document_fields'), kwargs.get('document_fields', None))
155        setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None))
156        setattr(self, "_{}".format('document_id_guid'), kwargs.get('document_id_guid', None))
157        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
158        setattr(self, "_{}".format('include_in_download'), kwargs.get('include_in_download', None))
159        setattr(self, "_{}".format('include_in_download_metadata'), kwargs.get('include_in_download_metadata', None))
160        setattr(self, "_{}".format('is_ace_gen_document'), kwargs.get('is_ace_gen_document', None))
161        setattr(self, "_{}".format('is_doc_gen_document'), kwargs.get('is_doc_gen_document', None))
162        setattr(self, "_{}".format('name'), kwargs.get('name', None))
163        setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None))
164        setattr(self, "_{}".format('order'), kwargs.get('order', None))
165        setattr(self, "_{}".format('pages'), kwargs.get('pages', None))
166        setattr(self, "_{}".format('signer_must_acknowledge'), kwargs.get('signer_must_acknowledge', None))
167        setattr(self, "_{}".format('signer_must_acknowledge_metadata'), kwargs.get('signer_must_acknowledge_metadata', None))
168        setattr(self, "_{}".format('size_bytes'), kwargs.get('size_bytes', None))
169        setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None))
170        setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None))
171        setattr(self, "_{}".format('type'), kwargs.get('type', None))
172        setattr(self, "_{}".format('uri'), kwargs.get('uri', None))
173
174    @property
175    def added_recipient_ids(self):
176        """Gets the added_recipient_ids of this EnvelopeDocument.  # noqa: E501
177
178          # noqa: E501
179
180        :return: The added_recipient_ids of this EnvelopeDocument.  # noqa: E501
181        :rtype: list[str]
182        """
183        return self._added_recipient_ids
184
185    @added_recipient_ids.setter
186    def added_recipient_ids(self, added_recipient_ids):
187        """Sets the added_recipient_ids of this EnvelopeDocument.
188
189          # noqa: E501
190
191        :param added_recipient_ids: The added_recipient_ids of this EnvelopeDocument.  # noqa: E501
192        :type: list[str]
193        """
194
195        self._added_recipient_ids = added_recipient_ids
196
197    @property
198    def attachment_tab_id(self):
199        """Gets the attachment_tab_id of this EnvelopeDocument.  # noqa: E501
200
201          # noqa: E501
202
203        :return: The attachment_tab_id of this EnvelopeDocument.  # noqa: E501
204        :rtype: str
205        """
206        return self._attachment_tab_id
207
208    @attachment_tab_id.setter
209    def attachment_tab_id(self, attachment_tab_id):
210        """Sets the attachment_tab_id of this EnvelopeDocument.
211
212          # noqa: E501
213
214        :param attachment_tab_id: The attachment_tab_id of this EnvelopeDocument.  # noqa: E501
215        :type: str
216        """
217
218        self._attachment_tab_id = attachment_tab_id
219
220    @property
221    def authoritative_copy(self):
222        """Gets the authoritative_copy of this EnvelopeDocument.  # noqa: E501
223
224        Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.  # noqa: E501
225
226        :return: The authoritative_copy of this EnvelopeDocument.  # noqa: E501
227        :rtype: str
228        """
229        return self._authoritative_copy
230
231    @authoritative_copy.setter
232    def authoritative_copy(self, authoritative_copy):
233        """Sets the authoritative_copy of this EnvelopeDocument.
234
235        Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.  # noqa: E501
236
237        :param authoritative_copy: The authoritative_copy of this EnvelopeDocument.  # noqa: E501
238        :type: str
239        """
240
241        self._authoritative_copy = authoritative_copy
242
243    @property
244    def authoritative_copy_metadata(self):
245        """Gets the authoritative_copy_metadata of this EnvelopeDocument.  # noqa: E501
246
247        Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents.  # noqa: E501
248
249        :return: The authoritative_copy_metadata of this EnvelopeDocument.  # noqa: E501
250        :rtype: PropertyMetadata
251        """
252        return self._authoritative_copy_metadata
253
254    @authoritative_copy_metadata.setter
255    def authoritative_copy_metadata(self, authoritative_copy_metadata):
256        """Sets the authoritative_copy_metadata of this EnvelopeDocument.
257
258        Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents.  # noqa: E501
259
260        :param authoritative_copy_metadata: The authoritative_copy_metadata of this EnvelopeDocument.  # noqa: E501
261        :type: PropertyMetadata
262        """
263
264        self._authoritative_copy_metadata = authoritative_copy_metadata
265
266    @property
267    def available_document_types(self):
268        """Gets the available_document_types of this EnvelopeDocument.  # noqa: E501
269
270          # noqa: E501
271
272        :return: The available_document_types of this EnvelopeDocument.  # noqa: E501
273        :rtype: list[SignatureType]
274        """
275        return self._available_document_types
276
277    @available_document_types.setter
278    def available_document_types(self, available_document_types):
279        """Sets the available_document_types of this EnvelopeDocument.
280
281          # noqa: E501
282
283        :param available_document_types: The available_document_types of this EnvelopeDocument.  # noqa: E501
284        :type: list[SignatureType]
285        """
286
287        self._available_document_types = available_document_types
288
289    @property
290    def contains_pdf_form_fields(self):
291        """Gets the contains_pdf_form_fields of this EnvelopeDocument.  # noqa: E501
292
293          # noqa: E501
294
295        :return: The contains_pdf_form_fields of this EnvelopeDocument.  # noqa: E501
296        :rtype: str
297        """
298        return self._contains_pdf_form_fields
299
300    @contains_pdf_form_fields.setter
301    def contains_pdf_form_fields(self, contains_pdf_form_fields):
302        """Sets the contains_pdf_form_fields of this EnvelopeDocument.
303
304          # noqa: E501
305
306        :param contains_pdf_form_fields: The contains_pdf_form_fields of this EnvelopeDocument.  # noqa: E501
307        :type: str
308        """
309
310        self._contains_pdf_form_fields = contains_pdf_form_fields
311
312    @property
313    def display(self):
314        """Gets the display of this EnvelopeDocument.  # noqa: E501
315
316          # noqa: E501
317
318        :return: The display of this EnvelopeDocument.  # noqa: E501
319        :rtype: str
320        """
321        return self._display
322
323    @display.setter
324    def display(self, display):
325        """Sets the display of this EnvelopeDocument.
326
327          # noqa: E501
328
329        :param display: The display of this EnvelopeDocument.  # noqa: E501
330        :type: str
331        """
332
333        self._display = display
334
335    @property
336    def display_metadata(self):
337        """Gets the display_metadata of this EnvelopeDocument.  # noqa: E501
338
339        Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents.  # noqa: E501
340
341        :return: The display_metadata of this EnvelopeDocument.  # noqa: E501
342        :rtype: PropertyMetadata
343        """
344        return self._display_metadata
345
346    @display_metadata.setter
347    def display_metadata(self, display_metadata):
348        """Sets the display_metadata of this EnvelopeDocument.
349
350        Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents.  # noqa: E501
351
352        :param display_metadata: The display_metadata of this EnvelopeDocument.  # noqa: E501
353        :type: PropertyMetadata
354        """
355
356        self._display_metadata = display_metadata
357
358    @property
359    def doc_gen_document_status(self):
360        """Gets the doc_gen_document_status of this EnvelopeDocument.  # noqa: E501
361
362          # noqa: E501
363
364        :return: The doc_gen_document_status of this EnvelopeDocument.  # noqa: E501
365        :rtype: str
366        """
367        return self._doc_gen_document_status
368
369    @doc_gen_document_status.setter
370    def doc_gen_document_status(self, doc_gen_document_status):
371        """Sets the doc_gen_document_status of this EnvelopeDocument.
372
373          # noqa: E501
374
375        :param doc_gen_document_status: The doc_gen_document_status of this EnvelopeDocument.  # noqa: E501
376        :type: str
377        """
378
379        self._doc_gen_document_status = doc_gen_document_status
380
381    @property
382    def doc_gen_errors(self):
383        """Gets the doc_gen_errors of this EnvelopeDocument.  # noqa: E501
384
385          # noqa: E501
386
387        :return: The doc_gen_errors of this EnvelopeDocument.  # noqa: E501
388        :rtype: list[DocGenSyntaxError]
389        """
390        return self._doc_gen_errors
391
392    @doc_gen_errors.setter
393    def doc_gen_errors(self, doc_gen_errors):
394        """Sets the doc_gen_errors of this EnvelopeDocument.
395
396          # noqa: E501
397
398        :param doc_gen_errors: The doc_gen_errors of this EnvelopeDocument.  # noqa: E501
399        :type: list[DocGenSyntaxError]
400        """
401
402        self._doc_gen_errors = doc_gen_errors
403
404    @property
405    def doc_gen_form_fields(self):
406        """Gets the doc_gen_form_fields of this EnvelopeDocument.  # noqa: E501
407
408          # noqa: E501
409
410        :return: The doc_gen_form_fields of this EnvelopeDocument.  # noqa: E501
411        :rtype: list[DocGenFormField]
412        """
413        return self._doc_gen_form_fields
414
415    @doc_gen_form_fields.setter
416    def doc_gen_form_fields(self, doc_gen_form_fields):
417        """Sets the doc_gen_form_fields of this EnvelopeDocument.
418
419          # noqa: E501
420
421        :param doc_gen_form_fields: The doc_gen_form_fields of this EnvelopeDocument.  # noqa: E501
422        :type: list[DocGenFormField]
423        """
424
425        self._doc_gen_form_fields = doc_gen_form_fields
426
427    @property
428    def document_base64(self):
429        """Gets the document_base64 of this EnvelopeDocument.  # noqa: E501
430
431          # noqa: E501
432
433        :return: The document_base64 of this EnvelopeDocument.  # noqa: E501
434        :rtype: str
435        """
436        return self._document_base64
437
438    @document_base64.setter
439    def document_base64(self, document_base64):
440        """Sets the document_base64 of this EnvelopeDocument.
441
442          # noqa: E501
443
444        :param document_base64: The document_base64 of this EnvelopeDocument.  # noqa: E501
445        :type: str
446        """
447
448        self._document_base64 = document_base64
449
450    @property
451    def document_fields(self):
452        """Gets the document_fields of this EnvelopeDocument.  # noqa: E501
453
454          # noqa: E501
455
456        :return: The document_fields of this EnvelopeDocument.  # noqa: E501
457        :rtype: list[NameValue]
458        """
459        return self._document_fields
460
461    @document_fields.setter
462    def document_fields(self, document_fields):
463        """Sets the document_fields of this EnvelopeDocument.
464
465          # noqa: E501
466
467        :param document_fields: The document_fields of this EnvelopeDocument.  # noqa: E501
468        :type: list[NameValue]
469        """
470
471        self._document_fields = document_fields
472
473    @property
474    def document_id(self):
475        """Gets the document_id of this EnvelopeDocument.  # noqa: E501
476
477        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.  # noqa: E501
478
479        :return: The document_id of this EnvelopeDocument.  # noqa: E501
480        :rtype: str
481        """
482        return self._document_id
483
484    @document_id.setter
485    def document_id(self, document_id):
486        """Sets the document_id of this EnvelopeDocument.
487
488        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.  # noqa: E501
489
490        :param document_id: The document_id of this EnvelopeDocument.  # noqa: E501
491        :type: str
492        """
493
494        self._document_id = document_id
495
496    @property
497    def document_id_guid(self):
498        """Gets the document_id_guid of this EnvelopeDocument.  # noqa: E501
499
500          # noqa: E501
501
502        :return: The document_id_guid of this EnvelopeDocument.  # noqa: E501
503        :rtype: str
504        """
505        return self._document_id_guid
506
507    @document_id_guid.setter
508    def document_id_guid(self, document_id_guid):
509        """Sets the document_id_guid of this EnvelopeDocument.
510
511          # noqa: E501
512
513        :param document_id_guid: The document_id_guid of this EnvelopeDocument.  # noqa: E501
514        :type: str
515        """
516
517        self._document_id_guid = document_id_guid
518
519    @property
520    def error_details(self):
521        """Gets the error_details of this EnvelopeDocument.  # noqa: E501
522
523        Array or errors.  # noqa: E501
524
525        :return: The error_details of this EnvelopeDocument.  # noqa: E501
526        :rtype: ErrorDetails
527        """
528        return self._error_details
529
530    @error_details.setter
531    def error_details(self, error_details):
532        """Sets the error_details of this EnvelopeDocument.
533
534        Array or errors.  # noqa: E501
535
536        :param error_details: The error_details of this EnvelopeDocument.  # noqa: E501
537        :type: ErrorDetails
538        """
539
540        self._error_details = error_details
541
542    @property
543    def include_in_download(self):
544        """Gets the include_in_download of this EnvelopeDocument.  # noqa: E501
545
546          # noqa: E501
547
548        :return: The include_in_download of this EnvelopeDocument.  # noqa: E501
549        :rtype: str
550        """
551        return self._include_in_download
552
553    @include_in_download.setter
554    def include_in_download(self, include_in_download):
555        """Sets the include_in_download of this EnvelopeDocument.
556
557          # noqa: E501
558
559        :param include_in_download: The include_in_download of this EnvelopeDocument.  # noqa: E501
560        :type: str
561        """
562
563        self._include_in_download = include_in_download
564
565    @property
566    def include_in_download_metadata(self):
567        """Gets the include_in_download_metadata of this EnvelopeDocument.  # noqa: E501
568
569        Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents.  # noqa: E501
570
571        :return: The include_in_download_metadata of this EnvelopeDocument.  # noqa: E501
572        :rtype: PropertyMetadata
573        """
574        return self._include_in_download_metadata
575
576    @include_in_download_metadata.setter
577    def include_in_download_metadata(self, include_in_download_metadata):
578        """Sets the include_in_download_metadata of this EnvelopeDocument.
579
580        Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents.  # noqa: E501
581
582        :param include_in_download_metadata: The include_in_download_metadata of this EnvelopeDocument.  # noqa: E501
583        :type: PropertyMetadata
584        """
585
586        self._include_in_download_metadata = include_in_download_metadata
587
588    @property
589    def is_ace_gen_document(self):
590        """Gets the is_ace_gen_document of this EnvelopeDocument.  # noqa: E501
591
592          # noqa: E501
593
594        :return: The is_ace_gen_document of this EnvelopeDocument.  # noqa: E501
595        :rtype: str
596        """
597        return self._is_ace_gen_document
598
599    @is_ace_gen_document.setter
600    def is_ace_gen_document(self, is_ace_gen_document):
601        """Sets the is_ace_gen_document of this EnvelopeDocument.
602
603          # noqa: E501
604
605        :param is_ace_gen_document: The is_ace_gen_document of this EnvelopeDocument.  # noqa: E501
606        :type: str
607        """
608
609        self._is_ace_gen_document = is_ace_gen_document
610
611    @property
612    def is_doc_gen_document(self):
613        """Gets the is_doc_gen_document of this EnvelopeDocument.  # noqa: E501
614
615          # noqa: E501
616
617        :return: The is_doc_gen_document of this EnvelopeDocument.  # noqa: E501
618        :rtype: str
619        """
620        return self._is_doc_gen_document
621
622    @is_doc_gen_document.setter
623    def is_doc_gen_document(self, is_doc_gen_document):
624        """Sets the is_doc_gen_document of this EnvelopeDocument.
625
626          # noqa: E501
627
628        :param is_doc_gen_document: The is_doc_gen_document of this EnvelopeDocument.  # noqa: E501
629        :type: str
630        """
631
632        self._is_doc_gen_document = is_doc_gen_document
633
634    @property
635    def name(self):
636        """Gets the name of this EnvelopeDocument.  # noqa: E501
637
638          # noqa: E501
639
640        :return: The name of this EnvelopeDocument.  # noqa: E501
641        :rtype: str
642        """
643        return self._name
644
645    @name.setter
646    def name(self, name):
647        """Sets the name of this EnvelopeDocument.
648
649          # noqa: E501
650
651        :param name: The name of this EnvelopeDocument.  # noqa: E501
652        :type: str
653        """
654
655        self._name = name
656
657    @property
658    def name_metadata(self):
659        """Gets the name_metadata of this EnvelopeDocument.  # noqa: E501
660
661        Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents.  # noqa: E501
662
663        :return: The name_metadata of this EnvelopeDocument.  # noqa: E501
664        :rtype: PropertyMetadata
665        """
666        return self._name_metadata
667
668    @name_metadata.setter
669    def name_metadata(self, name_metadata):
670        """Sets the name_metadata of this EnvelopeDocument.
671
672        Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents.  # noqa: E501
673
674        :param name_metadata: The name_metadata of this EnvelopeDocument.  # noqa: E501
675        :type: PropertyMetadata
676        """
677
678        self._name_metadata = name_metadata
679
680    @property
681    def order(self):
682        """Gets the order of this EnvelopeDocument.  # noqa: E501
683
684          # noqa: E501
685
686        :return: The order of this EnvelopeDocument.  # noqa: E501
687        :rtype: str
688        """
689        return self._order
690
691    @order.setter
692    def order(self, order):
693        """Sets the order of this EnvelopeDocument.
694
695          # noqa: E501
696
697        :param order: The order of this EnvelopeDocument.  # noqa: E501
698        :type: str
699        """
700
701        self._order = order
702
703    @property
704    def pages(self):
705        """Gets the pages of this EnvelopeDocument.  # noqa: E501
706
707          # noqa: E501
708
709        :return: The pages of this EnvelopeDocument.  # noqa: E501
710        :rtype: list[Page]
711        """
712        return self._pages
713
714    @pages.setter
715    def pages(self, pages):
716        """Sets the pages of this EnvelopeDocument.
717
718          # noqa: E501
719
720        :param pages: The pages of this EnvelopeDocument.  # noqa: E501
721        :type: list[Page]
722        """
723
724        self._pages = pages
725
726    @property
727    def signer_must_acknowledge(self):
728        """Gets the signer_must_acknowledge of this EnvelopeDocument.  # noqa: E501
729
730          # noqa: E501
731
732        :return: The signer_must_acknowledge of this EnvelopeDocument.  # noqa: E501
733        :rtype: str
734        """
735        return self._signer_must_acknowledge
736
737    @signer_must_acknowledge.setter
738    def signer_must_acknowledge(self, signer_must_acknowledge):
739        """Sets the signer_must_acknowledge of this EnvelopeDocument.
740
741          # noqa: E501
742
743        :param signer_must_acknowledge: The signer_must_acknowledge of this EnvelopeDocument.  # noqa: E501
744        :type: str
745        """
746
747        self._signer_must_acknowledge = signer_must_acknowledge
748
749    @property
750    def signer_must_acknowledge_metadata(self):
751        """Gets the signer_must_acknowledge_metadata of this EnvelopeDocument.  # noqa: E501
752
753        Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents.  # noqa: E501
754
755        :return: The signer_must_acknowledge_metadata of this EnvelopeDocument.  # noqa: E501
756        :rtype: PropertyMetadata
757        """
758        return self._signer_must_acknowledge_metadata
759
760    @signer_must_acknowledge_metadata.setter
761    def signer_must_acknowledge_metadata(self, signer_must_acknowledge_metadata):
762        """Sets the signer_must_acknowledge_metadata of this EnvelopeDocument.
763
764        Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents.  # noqa: E501
765
766        :param signer_must_acknowledge_metadata: The signer_must_acknowledge_metadata of this EnvelopeDocument.  # noqa: E501
767        :type: PropertyMetadata
768        """
769
770        self._signer_must_acknowledge_metadata = signer_must_acknowledge_metadata
771
772    @property
773    def size_bytes(self):
774        """Gets the size_bytes of this EnvelopeDocument.  # noqa: E501
775
776          # noqa: E501
777
778        :return: The size_bytes of this EnvelopeDocument.  # noqa: E501
779        :rtype: str
780        """
781        return self._size_bytes
782
783    @size_bytes.setter
784    def size_bytes(self, size_bytes):
785        """Sets the size_bytes of this EnvelopeDocument.
786
787          # noqa: E501
788
789        :param size_bytes: The size_bytes of this EnvelopeDocument.  # noqa: E501
790        :type: str
791        """
792
793        self._size_bytes = size_bytes
794
795    @property
796    def template_locked(self):
797        """Gets the template_locked of this EnvelopeDocument.  # noqa: E501
798
799        When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.   # noqa: E501
800
801        :return: The template_locked of this EnvelopeDocument.  # noqa: E501
802        :rtype: str
803        """
804        return self._template_locked
805
806    @template_locked.setter
807    def template_locked(self, template_locked):
808        """Sets the template_locked of this EnvelopeDocument.
809
810        When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.   # noqa: E501
811
812        :param template_locked: The template_locked of this EnvelopeDocument.  # noqa: E501
813        :type: str
814        """
815
816        self._template_locked = template_locked
817
818    @property
819    def template_required(self):
820        """Gets the template_required of this EnvelopeDocument.  # noqa: E501
821
822        When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.  # noqa: E501
823
824        :return: The template_required of this EnvelopeDocument.  # noqa: E501
825        :rtype: str
826        """
827        return self._template_required
828
829    @template_required.setter
830    def template_required(self, template_required):
831        """Sets the template_required of this EnvelopeDocument.
832
833        When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.  # noqa: E501
834
835        :param template_required: The template_required of this EnvelopeDocument.  # noqa: E501
836        :type: str
837        """
838
839        self._template_required = template_required
840
841    @property
842    def type(self):
843        """Gets the type of this EnvelopeDocument.  # noqa: E501
844
845          # noqa: E501
846
847        :return: The type of this EnvelopeDocument.  # noqa: E501
848        :rtype: str
849        """
850        return self._type
851
852    @type.setter
853    def type(self, type):
854        """Sets the type of this EnvelopeDocument.
855
856          # noqa: E501
857
858        :param type: The type of this EnvelopeDocument.  # noqa: E501
859        :type: str
860        """
861
862        self._type = type
863
864    @property
865    def uri(self):
866        """Gets the uri of this EnvelopeDocument.  # noqa: E501
867
868          # noqa: E501
869
870        :return: The uri of this EnvelopeDocument.  # noqa: E501
871        :rtype: str
872        """
873        return self._uri
874
875    @uri.setter
876    def uri(self, uri):
877        """Sets the uri of this EnvelopeDocument.
878
879          # noqa: E501
880
881        :param uri: The uri of this EnvelopeDocument.  # noqa: E501
882        :type: str
883        """
884
885        self._uri = uri
886
887    def to_dict(self):
888        """Returns the model properties as a dict"""
889        result = {}
890
891        for attr, _ in six.iteritems(self.swagger_types):
892            value = getattr(self, attr)
893            if isinstance(value, list):
894                result[attr] = list(map(
895                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
896                    value
897                ))
898            elif hasattr(value, "to_dict"):
899                result[attr] = value.to_dict()
900            elif isinstance(value, dict):
901                result[attr] = dict(map(
902                    lambda item: (item[0], item[1].to_dict())
903                    if hasattr(item[1], "to_dict") else item,
904                    value.items()
905                ))
906            else:
907                result[attr] = value
908        if issubclass(EnvelopeDocument, dict):
909            for key, value in self.items():
910                result[key] = value
911
912        return result
913
914    def to_str(self):
915        """Returns the string representation of the model"""
916        return pprint.pformat(self.to_dict())
917
918    def __repr__(self):
919        """For `print` and `pprint`"""
920        return self.to_str()
921
922    def __eq__(self, other):
923        """Returns true if both objects are equal"""
924        if not isinstance(other, EnvelopeDocument):
925            return False
926
927        return self.to_dict() == other.to_dict()
928
929    def __ne__(self, other):
930        """Returns true if both objects are not equal"""
931        if not isinstance(other, EnvelopeDocument):
932            return True
933
934        return self.to_dict() != other.to_dict()