Skip to content

README.md

Latest commit

 

History

History
189 lines (126 loc) · 12.9 KB

README.md

File metadata and controls

189 lines (126 loc) · 12.9 KB

Envelopes.Fields

Overview

Available Operations

get

Returns an envelope field 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.fields.get(field_id=6981.76)

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeFieldGetResponse

Errors

Error Type Status Code Content Type
models.EnvelopeFieldGetBadRequestError 400 application/json
models.EnvelopeFieldGetUnauthorizedError 401 application/json
models.EnvelopeFieldGetForbiddenError 403 application/json
models.EnvelopeFieldGetNotFoundError 404 application/json
models.EnvelopeFieldGetInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

create_many

Create multiple fields 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.fields.create_many(envelope_id="<id>", data=[])

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeFieldCreateManyResponse

Errors

Error Type Status Code Content Type
models.EnvelopeFieldCreateManyBadRequestError 400 application/json
models.EnvelopeFieldCreateManyUnauthorizedError 401 application/json
models.EnvelopeFieldCreateManyForbiddenError 403 application/json
models.EnvelopeFieldCreateManyInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

update_many

Update multiple envelope fields 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.fields.update_many(envelope_id="<id>", data=[])

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeFieldUpdateManyResponse

Errors

Error Type Status Code Content Type
models.EnvelopeFieldUpdateManyBadRequestError 400 application/json
models.EnvelopeFieldUpdateManyUnauthorizedError 401 application/json
models.EnvelopeFieldUpdateManyForbiddenError 403 application/json
models.EnvelopeFieldUpdateManyInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

delete

Delete an envelope field

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.envelopes.fields.delete(field_id=2481.37)

    # Handle response
    print(res)

Parameters

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

Response

models.EnvelopeFieldDeleteResponse

Errors

Error Type Status Code Content Type
models.EnvelopeFieldDeleteBadRequestError 400 application/json
models.EnvelopeFieldDeleteUnauthorizedError 401 application/json
models.EnvelopeFieldDeleteForbiddenError 403 application/json
models.EnvelopeFieldDeleteInternalServerError 500 application/json
models.APIError 4XX, 5XX */*