api.md

Attachment

Types:

from legalesign.types import AttachmentResponse, ListMeta, AttachmentListResponse

Methods:

• client.attachment.retrieve(attachment_id) -> AttachmentResponse
• client.attachment.list(**params) -> AttachmentListResponse
• client.attachment.delete(attachment_id) -> None
• client.attachment.upload(**params) -> None

Document

Types:

from legalesign.types import (
    DocumentStatusEnum,
    PdfFieldValidationEnum,
    DocumentCreateResponse,
    DocumentRetrieveResponse,
    DocumentListResponse,
    DocumentGetFieldsResponse,
)

Methods:

• client.document.create(**params) -> DocumentCreateResponse
• client.document.retrieve(doc_id) -> DocumentRetrieveResponse
• client.document.list(**params) -> DocumentListResponse
• client.document.archive(doc_id) -> None
• client.document.delete_permanently(doc_id) -> None
• client.document.download_audit_log(doc_id) -> BinaryAPIResponse
• client.document.get_fields(doc_id) -> DocumentGetFieldsResponse
• client.document.preview(**params) -> None

Group

Types:

from legalesign.types import GroupRetrieveResponse, GroupListResponse

Methods:

• client.group.create(**params) -> None
• client.group.retrieve(group_id) -> GroupRetrieveResponse
• client.group.update(group_id, **params) -> None
• client.group.list(**params) -> GroupListResponse

Invited

Types:

from legalesign.types import InvitedListResponse

Methods:

• client.invited.list(**params) -> InvitedListResponse
• client.invited.delete(invited_id) -> None

Member

Types:

from legalesign.types import MemberResponse, PermissionsEnum, MemberListResponse

Methods:

• client.member.create(**params) -> None
• client.member.retrieve(member_id) -> MemberResponse
• client.member.list(**params) -> MemberListResponse
• client.member.delete(member_id) -> None

Notifications

Types:

from legalesign.types import WebhookEventFilterEnum, NotificationListResponse

Methods:

• client.notifications.list() -> NotificationListResponse

Pdf

Methods:

• client.pdf.retrieve(doc_id) -> BinaryAPIResponse
• client.pdf.create_preview(**params) -> BinaryAPIResponse

Signer

Types:

from legalesign.types import (
    SignerStatusEnum,
    SignerRetrieveResponse,
    SignerGetRejectionReasonResponse,
    SignerRetrieveFieldsResponse,
)

Methods:

• client.signer.retrieve(signer_id) -> SignerRetrieveResponse
• client.signer.get_access_link(signer_id) -> None
• client.signer.get_rejection_reason(signer_id) -> SignerGetRejectionReasonResponse
• client.signer.reset(signer_id, **params) -> None
• client.signer.retrieve_fields(signer_id) -> SignerRetrieveFieldsResponse
• client.signer.send_reminder(signer_id, **params) -> None

Status

Types:

from legalesign.types import StatusResponse, StatusRetrieveAllResponse

Methods:

• client.status.retrieve(doc_id) -> StatusResponse
• client.status.retrieve_all(**params) -> StatusRetrieveAllResponse

Subscribe

Methods:

• client.subscribe.create_webhook(**params) -> None

Template

Types:

from legalesign.types import TemplateRetrieveResponse, TemplateListResponse

Methods:

• client.template.create(**params) -> None
• client.template.retrieve(template_id) -> TemplateRetrieveResponse
• client.template.update(template_id, **params) -> None
• client.template.list(**params) -> TemplateListResponse
• client.template.archive(template_id) -> None

Templatepdf

Types:

from legalesign.types import TemplatePdf, TemplatepdfListResponse, TemplatepdfGetEditLinkResponse

Methods:

• client.templatepdf.create(**params) -> None
• client.templatepdf.retrieve(pdf_id) -> TemplatePdf
• client.templatepdf.list(**params) -> TemplatepdfListResponse
• client.templatepdf.archive(pdf_id) -> None
• client.templatepdf.convert_tags(pdf_id) -> None
• client.templatepdf.get_edit_link(pdf_id) -> str

Fields

Types:

from legalesign.types.templatepdf import FieldListResponse

Methods:

• client.templatepdf.fields.create(pdf_id, **params) -> None
• client.templatepdf.fields.list(pdf_id) -> FieldListResponse

Unsubscribe

Methods:

• client.unsubscribe.delete_webhook(**params) -> None

User

Types:

from legalesign.types import TimezoneEnum, UserRetrieveResponse

Methods:

• client.user.create(**params) -> None
• client.user.retrieve(user_id) -> UserRetrieveResponse
• client.user.update(user_id, **params) -> None