Skip to content

README.md

Latest commit

 

History

History
196 lines (133 loc) · 13 KB

README.md

File metadata and controls

196 lines (133 loc) · 13 KB

Envelopes.Attachments

Overview

Available Operations

find

Find all attachments 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.attachments.find(envelope_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeAttachmentFindResponse

Errors

Error Type Status Code Content Type
models.EnvelopeAttachmentFindBadRequestError 400 application/json
models.EnvelopeAttachmentFindUnauthorizedError 401 application/json
models.EnvelopeAttachmentFindForbiddenError 403 application/json
models.EnvelopeAttachmentFindNotFoundError 404 application/json
models.EnvelopeAttachmentFindInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

create

Create a new attachment 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.attachments.create(envelope_id="<id>", data={
        "label": "<value>",
        "data": "https://lustrous-skeleton.info",
    })

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeAttachmentCreateResponse

Errors

Error Type Status Code Content Type
models.EnvelopeAttachmentCreateBadRequestError 400 application/json
models.EnvelopeAttachmentCreateUnauthorizedError 401 application/json
models.EnvelopeAttachmentCreateForbiddenError 403 application/json
models.EnvelopeAttachmentCreateInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

update

Update an existing attachment

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.envelopes.attachments.update(id="<id>", data={
        "label": "<value>",
        "data": "https://tough-premier.biz",
    })

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeAttachmentUpdateResponse

Errors

Error Type Status Code Content Type
models.EnvelopeAttachmentUpdateBadRequestError 400 application/json
models.EnvelopeAttachmentUpdateUnauthorizedError 401 application/json
models.EnvelopeAttachmentUpdateForbiddenError 403 application/json
models.EnvelopeAttachmentUpdateInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

delete

Delete an attachment 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.attachments.delete(id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeAttachmentDeleteResponse

Errors

Error Type Status Code Content Type
models.EnvelopeAttachmentDeleteBadRequestError 400 application/json
models.EnvelopeAttachmentDeleteUnauthorizedError 401 application/json
models.EnvelopeAttachmentDeleteForbiddenError 403 application/json
models.EnvelopeAttachmentDeleteInternalServerError 500 application/json
models.APIError 4XX, 5XX */*