Skip to content

README.md

Latest commit

 

History

History
305 lines (212 loc) · 21.5 KB

README.md

File metadata and controls

305 lines (212 loc) · 21.5 KB

Documents.Fields

Overview

Available Operations

get

Returns a single field. If you want to retrieve all the fields for a document, use the "Get Document" endpoint.

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.documents.fields.get(field_id=6077.81)

    # 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.FieldGetDocumentFieldResponse

Errors

Error Type Status Code Content Type
models.FieldGetDocumentFieldBadRequestError 400 application/json
models.FieldGetDocumentFieldUnauthorizedError 401 application/json
models.FieldGetDocumentFieldForbiddenError 403 application/json
models.FieldGetDocumentFieldNotFoundError 404 application/json
models.FieldGetDocumentFieldInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

create

Create a single field for a document.

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.documents.fields.create(document_id=8001.93, field={
        "type": documenso_sdk.FieldCreateDocumentFieldTypeNameRequest1.NAME,
        "recipient_id": 2564.68,
        "page_number": 791.77,
        "page_x": 7845.22,
        "page_y": 6843.16,
        "width": 3932.15,
        "height": 8879.89,
    })

    # Handle response
    print(res)

Parameters

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

Response

models.FieldCreateDocumentFieldResponse

Errors

Error Type Status Code Content Type
models.FieldCreateDocumentFieldBadRequestError 400 application/json
models.FieldCreateDocumentFieldUnauthorizedError 401 application/json
models.FieldCreateDocumentFieldForbiddenError 403 application/json
models.FieldCreateDocumentFieldInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

create_many

Create multiple fields for a document.

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.documents.fields.create_many(document_id=6257.51, fields=[
        {
            "type": documenso_sdk.FieldCreateDocumentFieldsTypeFreeSignature.FREE_SIGNATURE,
            "recipient_id": 679.35,
            "page_number": 5914.59,
            "page_x": 7253.11,
            "page_y": 8426.91,
            "width": 8995.55,
            "height": 9808.97,
        },
    ])

    # Handle response
    print(res)

Parameters

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

Response

models.FieldCreateDocumentFieldsResponse

Errors

Error Type Status Code Content Type
models.FieldCreateDocumentFieldsBadRequestError 400 application/json
models.FieldCreateDocumentFieldsUnauthorizedError 401 application/json
models.FieldCreateDocumentFieldsForbiddenError 403 application/json
models.FieldCreateDocumentFieldsInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

update

Update a single field for a document.

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.documents.fields.update(document_id=5956.26, field={
        "type": documenso_sdk.FieldUpdateDocumentFieldTypeFreeSignature.FREE_SIGNATURE,
        "id": 6955.16,
    })

    # Handle response
    print(res)

Parameters

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

Response

models.FieldUpdateDocumentFieldResponse

Errors

Error Type Status Code Content Type
models.FieldUpdateDocumentFieldBadRequestError 400 application/json
models.FieldUpdateDocumentFieldUnauthorizedError 401 application/json
models.FieldUpdateDocumentFieldForbiddenError 403 application/json
models.FieldUpdateDocumentFieldInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

update_many

Update multiple fields for a document.

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.documents.fields.update_many(document_id=9317.43, fields=[])

    # Handle response
    print(res)

Parameters

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

Response

models.FieldUpdateDocumentFieldsResponse

Errors

Error Type Status Code Content Type
models.FieldUpdateDocumentFieldsBadRequestError 400 application/json
models.FieldUpdateDocumentFieldsUnauthorizedError 401 application/json
models.FieldUpdateDocumentFieldsForbiddenError 403 application/json
models.FieldUpdateDocumentFieldsInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

delete

Delete document field

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.documents.fields.delete(field_id=4748.27)

    # 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.FieldDeleteDocumentFieldResponse

Errors

Error Type Status Code Content Type
models.FieldDeleteDocumentFieldBadRequestError 400 application/json
models.FieldDeleteDocumentFieldUnauthorizedError 401 application/json
models.FieldDeleteDocumentFieldForbiddenError 403 application/json
models.FieldDeleteDocumentFieldInternalServerError 500 application/json
models.APIError 4XX, 5XX */*