Skip to content

Latest commit

 

History

History
135 lines (87 loc) · 9.04 KB

README.md

File metadata and controls

135 lines (87 loc) · 9.04 KB

DirectLinkSDK

(templates.direct_link)

Overview

Available Operations

create

Create a direct link for a template

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.templates.direct_link.create(template_id=4865.89)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
template_id float ✔️ N/A
direct_recipient_id Optional[float] ➖ The of the recipient in the current template to transform into the primary recipient when the template is used.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.TemplateCreateTemplateDirectLinkResponse

Errors

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

delete

Delete a direct link for a template

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.templates.direct_link.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.TemplateDeleteTemplateDirectLinkResponse

Errors

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

toggle

Enable or disable a direct link for a template

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.templates.direct_link.toggle(template_id=722.9, enabled=True)

    # Handle response
    print(res)

Parameters

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

Response

models.TemplateToggleTemplateDirectLinkResponse

Errors

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