Skip to content

README.md

Latest commit

 

History

History
379 lines (256 loc) · 23.3 KB

README.md

File metadata and controls

379 lines (256 loc) · 23.3 KB

Envelopes

Overview

Available Operations

get

Returns an envelope 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.envelopes.get(envelope_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeGetResponse

Errors

Error Type Status Code Content Type
models.EnvelopeGetBadRequestError 400 application/json
models.EnvelopeGetUnauthorizedError 401 application/json
models.EnvelopeGetForbiddenError 403 application/json
models.EnvelopeGetNotFoundError 404 application/json
models.EnvelopeGetInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

create

Create an envelope using form data.

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.envelopes.create(payload={
        "title": "<value>",
        "type": documenso_sdk.EnvelopeCreateType.TEMPLATE,
    })

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
payload models.EnvelopeCreatePayload ✔️ N/A
files List[models.EnvelopeCreateFile] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.EnvelopeCreateResponse

Errors

Error Type Status Code Content Type
models.EnvelopeCreateBadRequestError 400 application/json
models.EnvelopeCreateUnauthorizedError 401 application/json
models.EnvelopeCreateForbiddenError 403 application/json
models.EnvelopeCreateInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

use

Create a document envelope from a template envelope. Upload custom files to replace the template PDFs and map them to specific envelope items using identifiers.

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.envelopes.use(payload={
        "envelope_id": "<id>",
    })

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
payload models.EnvelopeUsePayload ✔️ N/A
files List[models.EnvelopeUseFile] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.EnvelopeUseResponse

Errors

Error Type Status Code Content Type
models.EnvelopeUseBadRequestError 400 application/json
models.EnvelopeUseUnauthorizedError 401 application/json
models.EnvelopeUseForbiddenError 403 application/json
models.EnvelopeUseInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

update

Update envelope

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.envelopes.update(envelope_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
envelope_id str ✔️ N/A
data Optional[models.EnvelopeUpdateData] ➖ N/A
meta Optional[models.EnvelopeUpdateMeta] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.EnvelopeUpdateResponse

Errors

Error Type Status Code Content Type
models.EnvelopeUpdateBadRequestError 400 application/json
models.EnvelopeUpdateUnauthorizedError 401 application/json
models.EnvelopeUpdateForbiddenError 403 application/json
models.EnvelopeUpdateInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

delete

Delete envelope

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.envelopes.delete(envelope_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeDeleteResponse

Errors

Error Type Status Code Content Type
models.EnvelopeDeleteBadRequestError 400 application/json
models.EnvelopeDeleteUnauthorizedError 401 application/json
models.EnvelopeDeleteForbiddenError 403 application/json
models.EnvelopeDeleteInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

duplicate

Duplicate an envelope with all its settings

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.envelopes.duplicate(envelope_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeDuplicateResponse

Errors

Error Type Status Code Content Type
models.EnvelopeDuplicateBadRequestError 400 application/json
models.EnvelopeDuplicateUnauthorizedError 401 application/json
models.EnvelopeDuplicateForbiddenError 403 application/json
models.EnvelopeDuplicateInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

distribute

Send the envelope 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.envelopes.distribute(envelope_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeDistributeResponse

Errors

Error Type Status Code Content Type
models.EnvelopeDistributeBadRequestError 400 application/json
models.EnvelopeDistributeUnauthorizedError 401 application/json
models.EnvelopeDistributeForbiddenError 403 application/json
models.EnvelopeDistributeInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

redistribute

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

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.envelopes.redistribute(envelope_id="<id>", recipients=[])

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeRedistributeResponse

Errors

Error Type Status Code Content Type
models.EnvelopeRedistributeBadRequestError 400 application/json
models.EnvelopeRedistributeUnauthorizedError 401 application/json
models.EnvelopeRedistributeForbiddenError 403 application/json
models.EnvelopeRedistributeInternalServerError 500 application/json
models.APIError 4XX, 5XX */*