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