Skip to content

README.md

Latest commit

 

History

History
99 lines (66 loc) · 7.57 KB

README.md

File metadata and controls

99 lines (66 loc) · 7.57 KB

Document

Overview

Available Operations

document_get_many

Retrieve multiple documents by their IDs

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.document.document_get_many(document_ids=[])

    # Handle response
    print(res)

Parameters

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

Response

models.DocumentGetManyResponse

Errors

Error Type Status Code Content Type
models.DocumentGetManyBadRequestError 400 application/json
models.DocumentGetManyUnauthorizedError 401 application/json
models.DocumentGetManyForbiddenError 403 application/json
models.DocumentGetManyInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

document_download

Get a pre-signed download URL for the original or signed version of a 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.document.document_download(document_id=9550.11, version=documenso_sdk.DocumentDownloadBetaVersion.SIGNED)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
document_id float ✔️ The ID of the document to download.
version Optional[models.DocumentDownloadBetaVersion] ➖ 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.DocumentDownloadBetaResponse

Errors

Error Type Status Code Content Type
models.DocumentDownloadBetaBadRequestError 400 application/json
models.DocumentDownloadBetaUnauthorizedError 401 application/json
models.DocumentDownloadBetaForbiddenError 403 application/json
models.DocumentDownloadBetaNotFoundError 404 application/json
models.DocumentDownloadBetaInternalServerError 500 application/json
models.APIError 4XX, 5XX */*