Skip to content

Latest commit

 

History

History
110 lines (77 loc) · 12.7 KB

README.md

File metadata and controls

110 lines (77 loc) · 12.7 KB

Template

Overview

Available Operations

template_get_many

Retrieve multiple templates by their IDs

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.template.template_get_many(template_ids=[
        618.65,
        1418.73,
        1001.18,
    ])

    # Handle response
    print(res)

Parameters

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

Response

models.TemplateGetManyResponse

Errors

Error Type Status Code Content Type
models.TemplateGetManyBadRequestError 400 application/json
models.TemplateGetManyUnauthorizedError 401 application/json
models.TemplateGetManyForbiddenError 403 application/json
models.TemplateGetManyInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

template_create_template_temporary

You will need to upload the PDF to the provided URL returned. Note: Once V2 API is released, this will be removed since we will allow direct uploads, instead of using an upload URL.

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.template.template_create_template_temporary(title="<value>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
title str ✔️ N/A
folder_id Optional[str] ➖ N/A
external_id OptionalNullable[str] ➖ N/A
visibility Optional[models.TemplateCreateTemplateTemporaryVisibilityRequest] ➖ N/A
global_access_auth List[models.TemplateCreateTemplateTemporaryGlobalAccessAuthRequest] ➖ N/A
global_action_auth List[models.TemplateCreateTemplateTemporaryGlobalActionAuthRequest] ➖ N/A
public_title Optional[str] ➖ N/A
public_description Optional[str] ➖ N/A
type Optional[models.TemplateCreateTemplateTemporaryTypeRequest] ➖ N/A
meta Optional[models.TemplateCreateTemplateTemporaryMeta] ➖ N/A
attachments List[models.TemplateCreateTemplateTemporaryAttachment] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.TemplateCreateTemplateTemporaryResponse

Errors

Error Type Status Code Content Type
models.TemplateCreateTemplateTemporaryBadRequestError 400 application/json
models.TemplateCreateTemplateTemporaryUnauthorizedError 401 application/json
models.TemplateCreateTemplateTemporaryForbiddenError 403 application/json
models.TemplateCreateTemplateTemporaryInternalServerError 500 application/json
models.APIError 4XX, 5XX */*