Skip to content

Latest commit

 

History

History
290 lines (197 loc) · 21.8 KB

README.md

File metadata and controls

290 lines (197 loc) · 21.8 KB

TemplatesRecipients

(templates.recipients)

Overview

Available Operations

  • get - Get template recipient
  • create - Create template recipient
  • create_many - Create template recipients
  • update - Update template recipient
  • update_many - Update template recipients
  • delete - Delete template recipient

get

Returns a single recipient. If you want to retrieve all the recipients 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.recipients.get(recipient_id=7003.47)

    # Handle response
    print(res)

Parameters

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

Response

models.RecipientGetTemplateRecipientResponse

Errors

Error Type Status Code Content Type
models.RecipientGetTemplateRecipientBadRequestError 400 application/json
models.RecipientGetTemplateRecipientNotFoundError 404 application/json
models.RecipientGetTemplateRecipientInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

create

Create a single recipient 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.recipients.create(template_id=4865.89, recipient={
        "email": "[email protected]",
        "name": "<value>",
        "role": documenso_sdk.RecipientCreateTemplateRecipientRoleRequestBody.CC,
    })

    # Handle response
    print(res)

Parameters

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

Response

models.RecipientCreateTemplateRecipientResponse

Errors

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

create_many

Create multiple recipients 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.recipients.create_many(template_id=5158.41, recipients=[
        {
            "email": "[email protected]",
            "name": "<value>",
            "role": documenso_sdk.RecipientCreateTemplateRecipientsRoleRequestBody.APPROVER,
        },
        {
            "email": "[email protected]",
            "name": "<value>",
            "role": documenso_sdk.RecipientCreateTemplateRecipientsRoleRequestBody.APPROVER,
        },
    ])

    # Handle response
    print(res)

Parameters

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

Response

models.RecipientCreateTemplateRecipientsResponse

Errors

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

update

Update a single recipient 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.recipients.update(template_id=8574.78, recipient={
        "id": 5971.29,
    })

    # Handle response
    print(res)

Parameters

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

Response

models.RecipientUpdateTemplateRecipientResponse

Errors

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

update_many

Update multiple recipients 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.recipients.update_many(template_id=4057.69, recipients=[
        {
            "id": 5359.16,
        },
        {
            "id": 8982.15,
        },
    ])

    # Handle response
    print(res)

Parameters

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

Response

models.RecipientUpdateTemplateRecipientsResponse

Errors

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

delete

Delete template recipient

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.templates.recipients.delete(recipient_id=5459.07)

    # Handle response
    print(res)

Parameters

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

Response

models.RecipientDeleteTemplateRecipientResponse

Errors

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