Skip to content

Latest commit

 

History

History
322 lines (214 loc) · 23.7 KB

README.md

File metadata and controls

322 lines (214 loc) · 23.7 KB

Templates

(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.QueryParamType] ➖ Filter templates by type.
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.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=7003.47)

    # 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.TemplateGetTemplateByIDNotFoundError 404 application/json
models.TemplateGetTemplateByIDInternalServerError 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=8574.78)

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

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

    # 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.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=6626.9, recipients=[
        {
            "id": 6473.53,
            "email": "[email protected]",
        },
        {
            "id": 3772.31,
            "email": "[email protected]",
        },
    ])

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
template_id float ✔️ N/A
recipients List[models.TemplateCreateDocumentFromTemplateRecipientRequestBody] ✔️ The information of the recipients to create the document with.
distribute_document Optional[bool] ➖ Whether to create the document as pending and distribute it to recipients.
custom_document_data_id Optional[str] ➖ The data ID of an alternative PDF to use when creating the document. If not provided, the PDF attached to the template will be used.
prefill_fields List[models.PrefillField] ➖ The fields to prefill on the document before sending it out. Useful when you want to create a document from an existing template and pre-fill the fields with specific values.
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.TemplateCreateDocumentFromTemplateInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

move_to_team

Move a template to a team

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.templates.move_to_team(template_id=8301.72, team_id=6724.78)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
template_id float ✔️ The ID of the template to move to.
team_id float ✔️ The ID of the team to move the template to.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.TemplateMoveTemplateToTeamResponse

Errors

Error Type Status Code Content Type
models.TemplateMoveTemplateToTeamBadRequestError 400 application/json
models.TemplateMoveTemplateToTeamInternalServerError 500 application/json
models.APIError 4XX, 5XX */*