Boldsign.Document (Boldsign v0.5.3)

BoldSign Document API.

Summary

Functions

create(client, params)

Creates a document draft.

create_embedded_edit_url(client, document_id, params \\ %{})

Creates an embedded edit URL for a document.

create_embedded_request_url(client, params)

Creates an embedded request URL.

delete(client, document_id)

Deletes a document.

download(client, document_id)

Downloads a document.

edit(client, params)

Edits a document.

get_embedded_sign_link(client, document_id, params)

Creates an embedded signing link.

get_properties(client, document_id)

Gets the properties of a document.

list(client, params \\ [])

Lists documents.

remind(client, document_id, params \\ %{})

Reminds signers about a document.

revoke(client, document_id, params \\ %{})

Revokes a document.

send(client, params)

Sends a document for signature.

Functions

create(client, params)

Creates a document draft.

create_embedded_edit_url(client, document_id, params \\ %{})

Creates an embedded edit URL for a document.

create_embedded_request_url(client, params)

Creates an embedded request URL.

delete(client, document_id)

Deletes a document.

download(client, document_id)

Downloads a document.

edit(client, params)

Edits a document.

get_embedded_sign_link(client, document_id, params)

Creates an embedded signing link.

get_properties(client, document_id)

Gets the properties of a document.

list(client, params \\ [])

Lists documents.

remind(client, document_id, params \\ %{})

Reminds signers about a document.

revoke(client, document_id, params \\ %{})

Revokes a document.

send(client, params)

Sends a document for signature.

Supports two modes:

JSON (default): params are sent as JSON, including :fileUrls.
Multipart (:files): when non-empty Boldsign.File tuples are passed, the request is sent as multipart form data with files + JSON-stringified param fields (matching BoldSign's official SDK conventions).