Skip to content

README.md

Latest commit

 

History

History
345 lines (237 loc) · 30.7 KB

README.md

File metadata and controls

345 lines (237 loc) · 30.7 KB

Templates

Overview

Available Operations

find

Find templates 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.templates.find()

    # 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.TemplateFindTemplatesQueryParamType] ➖ Filter templates by type.
folder_id Optional[str] ➖ The ID of the folder to filter templates by.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.TemplateFindTemplatesResponse

Errors

Error Type Status Code Content Type
models.TemplateFindTemplatesBadRequestError 400 application/json
models.TemplateFindTemplatesUnauthorizedError 401 application/json
models.TemplateFindTemplatesForbiddenError 403 application/json
models.TemplateFindTemplatesNotFoundError 404 application/json
models.TemplateFindTemplatesInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

get

Get template

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.templates.get(template_id=2128.54)

    # Handle response
    print(res)

Parameters

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

Response

models.TemplateGetTemplateByIDResponse

Errors

Error Type Status Code Content Type
models.TemplateGetTemplateByIDBadRequestError 400 application/json
models.TemplateGetTemplateByIDUnauthorizedError 401 application/json
models.TemplateGetTemplateByIDForbiddenError 403 application/json
models.TemplateGetTemplateByIDNotFoundError 404 application/json
models.TemplateGetTemplateByIDInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

create

Create a new template

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.templates.create(payload={
        "title": "<value>",
    }, file={
        "file_name": "example.file",
        "content": open("example.file", "rb"),
    })

    # Handle response
    print(res)

Parameters

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

Response

models.TemplateCreateTemplateResponse

Errors

Error Type Status Code Content Type
models.TemplateCreateTemplateBadRequestError 400 application/json
models.TemplateCreateTemplateUnauthorizedError 401 application/json
models.TemplateCreateTemplateForbiddenError 403 application/json
models.TemplateCreateTemplateInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

update

Update template

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.templates.update(template_id=9404.77)

    # Handle response
    print(res)

Parameters

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

Response

models.TemplateUpdateTemplateResponse

Errors

Error Type Status Code Content Type
models.TemplateUpdateTemplateBadRequestError 400 application/json
models.TemplateUpdateTemplateUnauthorizedError 401 application/json
models.TemplateUpdateTemplateForbiddenError 403 application/json
models.TemplateUpdateTemplateInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

duplicate

Duplicate template

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.templates.duplicate(template_id=2490.16)

    # Handle response
    print(res)

Parameters

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

Response

models.TemplateDuplicateTemplateResponse

Errors

Error Type Status Code Content Type
models.TemplateDuplicateTemplateBadRequestError 400 application/json
models.TemplateDuplicateTemplateUnauthorizedError 401 application/json
models.TemplateDuplicateTemplateForbiddenError 403 application/json
models.TemplateDuplicateTemplateInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

delete

Delete template

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.templates.delete(template_id=536.89)

    # Handle response
    print(res)

Parameters

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

Response

models.TemplateDeleteTemplateResponse

Errors

Error Type Status Code Content Type
models.TemplateDeleteTemplateBadRequestError 400 application/json
models.TemplateDeleteTemplateUnauthorizedError 401 application/json
models.TemplateDeleteTemplateForbiddenError 403 application/json
models.TemplateDeleteTemplateInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

use

Use the template to create a document

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.templates.use(template_id=7392.96, recipients=[])

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
template_id float ✔️ N/A
recipients List[models.TemplateCreateDocumentFromTemplateRecipientRequest] ✔️ N/A
external_id Optional[str] ➖ N/A
distribute_document Optional[bool] ➖ N/A
custom_document_data_id Optional[str] ➖ N/A
custom_document_data List[models.TemplateCreateDocumentFromTemplateCustomDocumentDatum] ➖ N/A
folder_id Optional[str] ➖ N/A
prefill_fields List[models.TemplateCreateDocumentFromTemplatePrefillFieldUnion] ➖ N/A
override Optional[models.TemplateCreateDocumentFromTemplateOverride] ➖ N/A
attachments List[models.TemplateCreateDocumentFromTemplateAttachment] ➖ N/A
form_values Dict[str, models.TemplateCreateDocumentFromTemplateFormValuesRequest] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.TemplateCreateDocumentFromTemplateResponse

Errors

Error Type Status Code Content Type
models.TemplateCreateDocumentFromTemplateBadRequestError 400 application/json
models.TemplateCreateDocumentFromTemplateUnauthorizedError 401 application/json
models.TemplateCreateDocumentFromTemplateForbiddenError 403 application/json
models.TemplateCreateDocumentFromTemplateInternalServerError 500 application/json
models.APIError 4XX, 5XX */*