Documents

Agreement Documents

class AgreementDocument(echosign_id, mime_type, name, page_count, supporting_document=False, field_name=None)

Represents a document used in an Agreement.

echosign_id

The ID of the Document which can be used to retrieve its file stream

mime_type

The MIME type of the document

name

The name of the document

page_count

The number of pages in the document

supporting_document

Whether or not this document is a “supporting document” as specified by the API

field_name

If a supporting document, what the name is of the supporting document field

Library Documents

class LibraryDocument(account, echosign_id, template_type, name, modified_date, scope)

Represents a Library Document in Echosign. When pulling all Library Documents, only the echosign_id, template_type, modified_date, name, and scope are available. Accessing all other attributes results in an HTTP request to pull the full document information.

account

EchosignAccount – An instance of EchosignAccount. All Agreement actions will be conducted under this account.

echosign_id

str – The ID for this document in Echosign

document

bool – If this LibraryDocument is a document in Echosign

form_field_layer

bool – If this LibraryDocument is a form field layer

modified_date

datetime – The day on which the LibraryDocument was last modified

name

str – The name of the LibraryDocument in Echosign

scope

str – The visibility of this LibraryDocument, either ‘PERSONAL’, ‘SHARED’, or ‘GLOBAL”

GLOBAL = 'GLOBAL'
PERSONAL = 'PERSONAL'
SHARED = 'SHARED'
audit_trail_file

The PDF file of the audit for this Library Document.

delete()

Deletes the LibraryDocument from Echosign. It will not be visible on the Manage page.

classmethod json_to_agreement(account, json_data)
classmethod json_to_agreements(account, json_data)
locale
retrieve_complete_document()

Retrieves the remaining data for the LibraryDocument, such as locale, status, and security options.

scope = None

Transient Documents

class TransientDocument(account, file_name, file, mime_type=None)

A document which can be used in Agreements - is deleted by Echosign after 7 days. The TransientDocument is created in Echosign on instantiation.

Parameters:
  • account – The EchosignAccount to be associated with this document
  • file_name (str) – The name of the file
  • file – The actual file object to upload to Echosign, accepts a stream of bytes.
  • mime_type – (optional) The MIME type of the file. Echosign will infer the type from the file extension if not provided.
file_name

The name of the file

file

The actual file object to upload to Echosign

mime_type

The MIME type of the file

document_id

The ID provided by Echosign, used to reference it in creating agreements

expiration_date

The date Echosign will delete this document (not provided by Echosign, calculated for convenience)