Skip to content

README.md

Latest commit

 

History

History
295 lines (202 loc) · 24.1 KB

README.md

File metadata and controls

295 lines (202 loc) · 24.1 KB

Documents.Recipients

Overview

Available Operations

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

get

Returns a single recipient. If you want to retrieve all the recipients for a document, use the "Get Document" endpoint.

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.documents.recipients.get(recipient_id=874.3)

    # 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.RecipientGetDocumentRecipientResponse

Errors

Error Type Status Code Content Type
models.RecipientGetDocumentRecipientBadRequestError 400 application/json
models.RecipientGetDocumentRecipientUnauthorizedError 401 application/json
models.RecipientGetDocumentRecipientForbiddenError 403 application/json
models.RecipientGetDocumentRecipientNotFoundError 404 application/json
models.RecipientGetDocumentRecipientInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

create

Create a single recipient for a document.

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.documents.recipients.create(document_id=3058.31, recipient={
        "email": "Ila.Steuber@yahoo.com",
        "name": "<value>",
        "role": documenso_sdk.RecipientCreateDocumentRecipientRoleRequest.ASSISTANT,
    })

    # Handle response
    print(res)

Parameters

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

Response

models.RecipientCreateDocumentRecipientResponse

Errors

Error Type Status Code Content Type
models.RecipientCreateDocumentRecipientBadRequestError 400 application/json
models.RecipientCreateDocumentRecipientUnauthorizedError 401 application/json
models.RecipientCreateDocumentRecipientForbiddenError 403 application/json
models.RecipientCreateDocumentRecipientInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

create_many

Create multiple recipients for a document.

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.documents.recipients.create_many(document_id=9983.95, recipients=[
        {
            "email": "Roosevelt_Baumbach@yahoo.com",
            "name": "<value>",
            "role": documenso_sdk.RecipientCreateDocumentRecipientsRoleRequest.CC,
        },
    ])

    # Handle response
    print(res)

Parameters

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

Response

models.RecipientCreateDocumentRecipientsResponse

Errors

Error Type Status Code Content Type
models.RecipientCreateDocumentRecipientsBadRequestError 400 application/json
models.RecipientCreateDocumentRecipientsUnauthorizedError 401 application/json
models.RecipientCreateDocumentRecipientsForbiddenError 403 application/json
models.RecipientCreateDocumentRecipientsInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

update

Update a single recipient for a document.

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.documents.recipients.update(document_id=7045.62, recipient={
        "id": 2224.05,
    })

    # Handle response
    print(res)

Parameters

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

Response

models.RecipientUpdateDocumentRecipientResponse

Errors

Error Type Status Code Content Type
models.RecipientUpdateDocumentRecipientBadRequestError 400 application/json
models.RecipientUpdateDocumentRecipientUnauthorizedError 401 application/json
models.RecipientUpdateDocumentRecipientForbiddenError 403 application/json
models.RecipientUpdateDocumentRecipientInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

update_many

Update multiple recipients for a document.

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.documents.recipients.update_many(document_id=3189.76, recipients=[])

    # Handle response
    print(res)

Parameters

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

Response

models.RecipientUpdateDocumentRecipientsResponse

Errors

Error Type Status Code Content Type
models.RecipientUpdateDocumentRecipientsBadRequestError 400 application/json
models.RecipientUpdateDocumentRecipientsUnauthorizedError 401 application/json
models.RecipientUpdateDocumentRecipientsForbiddenError 403 application/json
models.RecipientUpdateDocumentRecipientsInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

delete

Delete document recipient

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.documents.recipients.delete(recipient_id=5490.43)

    # 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.RecipientDeleteDocumentRecipientResponse

Errors

Error Type Status Code Content Type
models.RecipientDeleteDocumentRecipientBadRequestError 400 application/json
models.RecipientDeleteDocumentRecipientUnauthorizedError 401 application/json
models.RecipientDeleteDocumentRecipientForbiddenError 403 application/json
models.RecipientDeleteDocumentRecipientInternalServerError 500 application/json
models.APIError 4XX, 5XX */*