Skip to content

README.md

Latest commit

 

History

History
161 lines (113 loc) · 14.6 KB

README.md

File metadata and controls

161 lines (113 loc) · 14.6 KB

Envelope

Overview

Available Operations

envelope_find

Find envelopes based on 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.envelope.envelope_find(order_by_direction=documenso_sdk.EnvelopeFindOrderByDirection.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.
type Optional[models.EnvelopeFindQueryParamType] ➖ Filter envelopes by type (DOCUMENT or TEMPLATE).
template_id Optional[float] ➖ Filter envelopes by the template ID used to create it.
source Optional[models.EnvelopeFindQueryParamSource] ➖ Filter envelopes by how it was created.
status Optional[models.EnvelopeFindQueryParamStatus] ➖ Filter envelopes by the current status.
folder_id Optional[str] ➖ Filter envelopes by folder ID.
order_by_column Optional[models.EnvelopeFindOrderByColumn] ➖ N/A
order_by_direction Optional[models.EnvelopeFindOrderByDirection] ➖ Sort direction.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.EnvelopeFindResponse

Errors

Error Type Status Code Content Type
models.EnvelopeFindBadRequestError 400 application/json
models.EnvelopeFindUnauthorizedError 401 application/json
models.EnvelopeFindForbiddenError 403 application/json
models.EnvelopeFindNotFoundError 404 application/json
models.EnvelopeFindInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

envelope_audit_log_find

Find audit logs based on a search criteria

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.envelope.envelope_audit_log_find(envelope_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
envelope_id str ✔️ Envelope ID
page Optional[float] ➖ The pagination page number, starts at 1.
per_page Optional[float] ➖ The number of items per page.
order_by_column Optional[models.EnvelopeAuditLogFindOrderByColumn] ➖ N/A
order_by_direction Optional[models.EnvelopeAuditLogFindOrderByDirection] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.EnvelopeAuditLogFindResponse

Errors

Error Type Status Code Content Type
models.EnvelopeAuditLogFindBadRequestError 400 application/json
models.EnvelopeAuditLogFindUnauthorizedError 401 application/json
models.EnvelopeAuditLogFindForbiddenError 403 application/json
models.EnvelopeAuditLogFindNotFoundError 404 application/json
models.EnvelopeAuditLogFindInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

envelope_get_many

Retrieve multiple envelopes by their IDs

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.envelope.envelope_get_many(ids={
        "type": documenso_sdk.TypeEnvelopeID.ENVELOPE_ID,
        "ids": [],
    })

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeGetManyResponse

Errors

Error Type Status Code Content Type
models.EnvelopeGetManyBadRequestError 400 application/json
models.EnvelopeGetManyUnauthorizedError 401 application/json
models.EnvelopeGetManyForbiddenError 403 application/json
models.EnvelopeGetManyInternalServerError 500 application/json
models.APIError 4XX, 5XX */*