Skip to content

README.md

Latest commit

 

History

History
194 lines (131 loc) · 15.1 KB

README.md

File metadata and controls

194 lines (131 loc) · 15.1 KB

Envelopes.Items

Overview

Available Operations

create_many

Create multiple envelope items for an envelope

Example Usage

from documenso_sdk import Documenso
import os


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

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

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeItemCreateManyResponse

Errors

Error Type Status Code Content Type
models.EnvelopeItemCreateManyBadRequestError 400 application/json
models.EnvelopeItemCreateManyUnauthorizedError 401 application/json
models.EnvelopeItemCreateManyForbiddenError 403 application/json
models.EnvelopeItemCreateManyInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

update_many

Update multiple envelope items for an envelope

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.envelopes.items.update_many(envelope_id="<id>", data=[])

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeItemUpdateManyResponse

Errors

Error Type Status Code Content Type
models.EnvelopeItemUpdateManyBadRequestError 400 application/json
models.EnvelopeItemUpdateManyUnauthorizedError 401 application/json
models.EnvelopeItemUpdateManyForbiddenError 403 application/json
models.EnvelopeItemUpdateManyInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

delete

Delete an envelope item from an envelope

Example Usage

from documenso_sdk import Documenso
import os


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

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

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeItemDeleteResponse

Errors

Error Type Status Code Content Type
models.EnvelopeItemDeleteBadRequestError 400 application/json
models.EnvelopeItemDeleteUnauthorizedError 401 application/json
models.EnvelopeItemDeleteForbiddenError 403 application/json
models.EnvelopeItemDeleteInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

download

Download an envelope item by its ID

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.items.download(envelope_item_id="<id>", version=documenso_sdk.EnvelopeItemDownloadVersion.SIGNED)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
envelope_item_id str ✔️ The ID of the envelope item to download.
version Optional[models.EnvelopeItemDownloadVersion] ➖ The version of the envelope item 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.EnvelopeItemDownloadResponse

Errors

Error Type Status Code Content Type
models.EnvelopeItemDownloadBadRequestError 400 application/json
models.EnvelopeItemDownloadUnauthorizedError 401 application/json
models.EnvelopeItemDownloadForbiddenError 403 application/json
models.EnvelopeItemDownloadNotFoundError 404 application/json
models.EnvelopeItemDownloadInternalServerError 500 application/json
models.APIError 4XX, 5XX */*