Documents

Overview

Available Operations

get - Get document
find - Find documents
create - Create document
update - Update document
delete - Delete document
duplicate - Duplicate document
distribute - Distribute document
redistribute - Redistribute document
download - Download document
~~create_v0~~ - Create document ⚠️ Deprecated

get

Returns a document given an ID

Example Usage

from documenso_sdk import Documenso
import os


with Documenso(
    api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

    res = documenso.documents.get(document_id=6150.61)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`document_id`	float	✔️	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.DocumentGetResponse

Errors

Error Type	Status Code	Content Type
models.DocumentGetBadRequestError	400	application/json
models.DocumentGetUnauthorizedError	401	application/json
models.DocumentGetForbiddenError	403	application/json
models.DocumentGetNotFoundError	404	application/json
models.DocumentGetInternalServerError	500	application/json
models.APIError	4XX, 5XX	/

find

Find documents based on a search criteria

Example Usage

import documenso_sdk
from documenso_sdk import Documenso
import os


with Documenso(
    api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

    res = documenso.documents.find(order_by_direction=documenso_sdk.DocumentFindOrderByDirection.DESC)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`query`	Optional[str]	➖	The search query.
`page`	Optional[float]	➖	The pagination page number, starts at 1.
`per_page`	Optional[float]	➖	The number of items per page.
`template_id`	Optional[float]	➖	Filter documents by the template ID used to create it.
`source`	Optional[models.DocumentFindQueryParamSource]	➖	Filter documents by how it was created.
`status`	Optional[models.DocumentFindQueryParamStatus]	➖	Filter documents by the current status
`folder_id`	Optional[str]	➖	Filter documents by folder ID
`order_by_column`	Optional[models.DocumentFindOrderByColumn]	➖	N/A
`order_by_direction`	Optional[models.DocumentFindOrderByDirection]	➖	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.DocumentFindResponse

Errors

Error Type	Status Code	Content Type
models.DocumentFindBadRequestError	400	application/json
models.DocumentFindUnauthorizedError	401	application/json
models.DocumentFindForbiddenError	403	application/json
models.DocumentFindNotFoundError	404	application/json
models.DocumentFindInternalServerError	500	application/json
models.APIError	4XX, 5XX	/

create

Create a document using form data.

Example Usage

from documenso_sdk import Documenso
import os


with Documenso(
    api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

    res = documenso.documents.create(payload={
        "title": "<value>",
    }, file={
        "file_name": "example.file",
        "content": open("example.file", "rb"),
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`payload`	models.DocumentCreatePayload	✔️	N/A
`file`	models.DocumentCreateFile	✔️	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.DocumentCreateResponse

Errors

Error Type	Status Code	Content Type
models.DocumentCreateBadRequestError	400	application/json
models.DocumentCreateUnauthorizedError	401	application/json
models.DocumentCreateForbiddenError	403	application/json
models.DocumentCreateInternalServerError	500	application/json
models.APIError	4XX, 5XX	/

update

Update document

Example Usage

from documenso_sdk import Documenso
import os


with Documenso(
    api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

    res = documenso.documents.update(document_id=3428.95)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`document_id`	float	✔️	N/A
`data`	Optional[models.DocumentUpdateData]	➖	N/A
`meta`	Optional[models.DocumentUpdateMeta]	➖	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.DocumentUpdateResponse

Errors

Error Type	Status Code	Content Type
models.DocumentUpdateBadRequestError	400	application/json
models.DocumentUpdateUnauthorizedError	401	application/json
models.DocumentUpdateForbiddenError	403	application/json
models.DocumentUpdateInternalServerError	500	application/json
models.APIError	4XX, 5XX	/

delete

Delete document

Example Usage

from documenso_sdk import Documenso
import os


with Documenso(
    api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

    res = documenso.documents.delete(document_id=3963.4)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`document_id`	float	✔️	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.DocumentDeleteResponse

Errors

Error Type	Status Code	Content Type
models.DocumentDeleteBadRequestError	400	application/json
models.DocumentDeleteUnauthorizedError	401	application/json
models.DocumentDeleteForbiddenError	403	application/json
models.DocumentDeleteInternalServerError	500	application/json
models.APIError	4XX, 5XX	/

duplicate

Duplicate document

Example Usage

from documenso_sdk import Documenso
import os


with Documenso(
    api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

    res = documenso.documents.duplicate(document_id=5285.3)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`document_id`	float	✔️	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.DocumentDuplicateResponse

Errors

Error Type	Status Code	Content Type
models.DocumentDuplicateBadRequestError	400	application/json
models.DocumentDuplicateUnauthorizedError	401	application/json
models.DocumentDuplicateForbiddenError	403	application/json
models.DocumentDuplicateInternalServerError	500	application/json
models.APIError	4XX, 5XX	/

distribute

Send the document out to recipients based on your distribution method

Example Usage

from documenso_sdk import Documenso
import os


with Documenso(
    api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

    res = documenso.documents.distribute(document_id=7548.74)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`document_id`	float	✔️	N/A
`meta`	Optional[models.DocumentDistributeMeta]	➖	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.DocumentDistributeResponse

Errors

Error Type	Status Code	Content Type
models.DocumentDistributeBadRequestError	400	application/json
models.DocumentDistributeUnauthorizedError	401	application/json
models.DocumentDistributeForbiddenError	403	application/json
models.DocumentDistributeInternalServerError	500	application/json
models.APIError	4XX, 5XX	/

redistribute

Redistribute the document to the provided recipients who have not actioned the document. Will use the distribution method set in the document

Example Usage

from documenso_sdk import Documenso
import os


with Documenso(
    api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

    res = documenso.documents.redistribute(document_id=9084.69, recipients=[
        6011.8,
        4441.56,
        4251.15,
    ])

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`document_id`	float	✔️	N/A
`recipients`	List[float]	✔️	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.DocumentRedistributeResponse

Errors

Error Type	Status Code	Content Type
models.DocumentRedistributeBadRequestError	400	application/json
models.DocumentRedistributeUnauthorizedError	401	application/json
models.DocumentRedistributeForbiddenError	403	application/json
models.DocumentRedistributeInternalServerError	500	application/json
models.APIError	4XX, 5XX	/

download

Download document

Example Usage

import documenso_sdk
from documenso_sdk import Documenso
import os


with Documenso(
    api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

    res = documenso.documents.download(document_id=5396.97, version=documenso_sdk.DocumentDownloadVersion.SIGNED)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`document_id`	float	✔️	The ID of the document to download.
`version`	Optional[models.DocumentDownloadVersion]	➖	The version of the document to download. "signed" returns the completed document with signatures, "original" returns the original uploaded document.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.DocumentDownloadResponse

Errors

Error Type	Status Code	Content Type
models.DocumentDownloadBadRequestError	400	application/json
models.DocumentDownloadUnauthorizedError	401	application/json
models.DocumentDownloadForbiddenError	403	application/json
models.DocumentDownloadNotFoundError	404	application/json
models.DocumentDownloadInternalServerError	500	application/json
models.APIError	4XX, 5XX	/

create_v0

You will need to upload the PDF to the provided URL returned. Note: Once V2 API is released, this will be removed since we will allow direct uploads, instead of using an upload URL.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

from documenso_sdk import Documenso
import os


with Documenso(
    api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

    res = documenso.documents.create_v0(title="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`title`	str	✔️	N/A
`external_id`	Optional[str]	➖	N/A
`visibility`	Optional[models.DocumentCreateDocumentTemporaryVisibilityRequest]	➖	N/A
`global_access_auth`	List[models.DocumentCreateDocumentTemporaryGlobalAccessAuthRequest]	➖	N/A
`global_action_auth`	List[models.DocumentCreateDocumentTemporaryGlobalActionAuthRequest]	➖	N/A
`form_values`	Dict[str, models.DocumentCreateDocumentTemporaryFormValuesRequest]	➖	N/A
`folder_id`	Optional[str]	➖	N/A
`recipients`	List[models.DocumentCreateDocumentTemporaryRecipientRequest]	➖	N/A
`attachments`	List[models.DocumentCreateDocumentTemporaryAttachment]	➖	N/A
`meta`	Optional[models.DocumentCreateDocumentTemporaryMeta]	➖	N/A
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.DocumentCreateDocumentTemporaryResponse

Errors

Error Type	Status Code	Content Type
models.DocumentCreateDocumentTemporaryBadRequestError	400	application/json
models.DocumentCreateDocumentTemporaryUnauthorizedError	401	application/json
models.DocumentCreateDocumentTemporaryForbiddenError	403	application/json
models.DocumentCreateDocumentTemporaryInternalServerError	500	application/json
models.APIError	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Documents

Overview

Available Operations

get

Example Usage

Parameters

Response

Errors

find

Example Usage

Parameters

Response

Errors

create

Example Usage

Parameters

Response

Errors

update

Example Usage

Parameters

Response

Errors

delete

Example Usage

Parameters

Response

Errors

duplicate

Example Usage

Parameters

Response

Errors

distribute

Example Usage

Parameters

Response

Errors

redistribute

Example Usage

Parameters

Response

Errors

download

Example Usage

Parameters

Response

Errors

create_v0

Example Usage

Parameters

Response

Errors