Skip to content

README.md

Latest commit

 

History

History
311 lines (218 loc) · 21.7 KB

README.md

File metadata and controls

311 lines (218 loc) · 21.7 KB

Templates.Fields

Overview

Available Operations

create

Create a single field for a template.

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.templates.fields.create(template_id=1203.71, field={
        "type": documenso_sdk.FieldCreateTemplateFieldTypeDateRequest1.DATE,
        "recipient_id": 2738.54,
        "page_number": 5735.12,
        "page_x": 2936.28,
        "page_y": 8594.41,
        "width": 7589.39,
        "height": 3122.23,
    })

    # Handle response
    print(res)

Parameters

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

Response

models.FieldCreateTemplateFieldResponse

Errors

Error Type Status Code Content Type
models.FieldCreateTemplateFieldBadRequestError 400 application/json
models.FieldCreateTemplateFieldUnauthorizedError 401 application/json
models.FieldCreateTemplateFieldForbiddenError 403 application/json
models.FieldCreateTemplateFieldInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

get

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

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.templates.fields.get(field_id=1152.82)

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

Errors

Error Type Status Code Content Type
models.FieldGetTemplateFieldBadRequestError 400 application/json
models.FieldGetTemplateFieldUnauthorizedError 401 application/json
models.FieldGetTemplateFieldForbiddenError 403 application/json
models.FieldGetTemplateFieldNotFoundError 404 application/json
models.FieldGetTemplateFieldInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

create_many

Create multiple fields for a template.

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.templates.fields.create_many(template_id=586.2, fields=[
        {
            "type": documenso_sdk.FieldCreateTemplateFieldsTypeSignatureRequest1.SIGNATURE,
            "recipient_id": 6990.12,
            "page_number": 3472.45,
            "page_x": 4747.87,
            "page_y": 1673.94,
            "width": 7215.37,
            "height": 9417.43,
        },
    ])

    # Handle response
    print(res)

Parameters

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

Response

models.FieldCreateTemplateFieldsResponse

Errors

Error Type Status Code Content Type
models.FieldCreateTemplateFieldsBadRequestError 400 application/json
models.FieldCreateTemplateFieldsUnauthorizedError 401 application/json
models.FieldCreateTemplateFieldsForbiddenError 403 application/json
models.FieldCreateTemplateFieldsInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

update

Update a single field for a template.

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.templates.fields.update(template_id=5083.07, field={
        "type": documenso_sdk.FieldUpdateTemplateFieldTypeTextRequest1.TEXT,
        "id": 1792.29,
    })

    # Handle response
    print(res)

Parameters

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

Response

models.FieldUpdateTemplateFieldResponse

Errors

Error Type Status Code Content Type
models.FieldUpdateTemplateFieldBadRequestError 400 application/json
models.FieldUpdateTemplateFieldUnauthorizedError 401 application/json
models.FieldUpdateTemplateFieldForbiddenError 403 application/json
models.FieldUpdateTemplateFieldInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

update_many

Update multiple fields for a template.

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.templates.fields.update_many(template_id=3969.1, fields=[
        {
            "type": documenso_sdk.FieldUpdateTemplateFieldsTypeDropdownRequest1.DROPDOWN,
            "id": 2460.72,
        },
    ])

    # Handle response
    print(res)

Parameters

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

Response

models.FieldUpdateTemplateFieldsResponse

Errors

Error Type Status Code Content Type
models.FieldUpdateTemplateFieldsBadRequestError 400 application/json
models.FieldUpdateTemplateFieldsUnauthorizedError 401 application/json
models.FieldUpdateTemplateFieldsForbiddenError 403 application/json
models.FieldUpdateTemplateFieldsInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

delete

Delete template field

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.templates.fields.delete(field_id=7996.49)

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

Errors

Error Type Status Code Content Type
models.FieldDeleteTemplateFieldBadRequestError 400 application/json
models.FieldDeleteTemplateFieldUnauthorizedError 401 application/json
models.FieldDeleteTemplateFieldForbiddenError 403 application/json
models.FieldDeleteTemplateFieldInternalServerError 500 application/json
models.APIError 4XX, 5XX */*