Skip to content

Latest commit

 

History

History
307 lines (214 loc) · 19.5 KB

README.md

File metadata and controls

307 lines (214 loc) · 19.5 KB

DocumentsFields

(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=7003.47)

    # 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.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=4865.89, field={
        "type": documenso_sdk.FieldCreateDocumentFieldTypeNumberRequestBody1.NUMBER,
        "recipient_id": 4174.58,
        "page_number": 1343.65,
        "page_x": 690.25,
        "page_y": 7964.74,
        "width": 9510.62,
        "height": 0.86,
    })

    # 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.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=5158.41, fields=[
        {
            "type": documenso_sdk.FieldCreateDocumentFieldsTypeCheckboxRequestBody1.CHECKBOX,
            "recipient_id": 2516.72,
            "page_number": 2304.17,
            "page_x": 7760.32,
            "page_y": 3376.66,
            "width": 3566.94,
            "height": 2768.94,
        },
        {
            "type": documenso_sdk.FieldCreateDocumentFieldsTypeNumberRequestBody1.NUMBER,
            "recipient_id": 5689.64,
            "page_number": 6483.69,
            "page_x": 7271.79,
            "page_y": 1891.56,
            "width": 7263.21,
            "height": 5043.41,
        },
    ])

    # 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.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=8574.78, field={
        "type": documenso_sdk.FieldUpdateDocumentFieldTypeTextRequestBody1.TEXT,
        "id": 3446.2,
    })

    # 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.FieldUpdateDocumentFieldInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

update_many

Update 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.update_many(document_id=4057.69, fields=[
        {
            "type": documenso_sdk.FieldUpdateDocumentFieldsTypeDateRequestBody1.DATE,
            "id": 8982.15,
        },
        {
            "type": documenso_sdk.FieldUpdateDocumentFieldsTypeNameRequestBody1.NAME,
            "id": 310.19,
        },
    ])

    # 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.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=5459.07)

    # 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.FieldDeleteDocumentFieldInternalServerError 500 application/json
models.APIError 4XX, 5XX */*