Skip to content

README.md

Latest commit

 

History

History
194 lines (131 loc) · 14.4 KB

README.md

File metadata and controls

194 lines (131 loc) · 14.4 KB

Folders

Overview

Available Operations

find

Find folders 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.folders.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.
parent_id Optional[str] ➖ N/A
type Optional[models.FolderFindFoldersQueryParamType] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.FolderFindFoldersResponse

Errors

Error Type Status Code Content Type
models.FolderFindFoldersBadRequestError 400 application/json
models.FolderFindFoldersUnauthorizedError 401 application/json
models.FolderFindFoldersForbiddenError 403 application/json
models.FolderFindFoldersNotFoundError 404 application/json
models.FolderFindFoldersInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

create

Creates a new folder in your team

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.folders.create(name="<value>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
name str ✔️ N/A
parent_id Optional[str] ➖ N/A
type Optional[models.FolderCreateFolderTypeRequest] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.FolderCreateFolderResponse

Errors

Error Type Status Code Content Type
models.FolderCreateFolderBadRequestError 400 application/json
models.FolderCreateFolderUnauthorizedError 401 application/json
models.FolderCreateFolderForbiddenError 403 application/json
models.FolderCreateFolderInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

update

Updates an existing folder

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.folders.update(folder_id="<id>", data={})

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
folder_id str ✔️ N/A
data models.FolderUpdateFolderData ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.FolderUpdateFolderResponse

Errors

Error Type Status Code Content Type
models.FolderUpdateFolderBadRequestError 400 application/json
models.FolderUpdateFolderUnauthorizedError 401 application/json
models.FolderUpdateFolderForbiddenError 403 application/json
models.FolderUpdateFolderInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

delete

Deletes an existing folder

Example Usage

from documenso_sdk import Documenso
import os


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

    res = documenso.folders.delete(folder_id="<id>")

    # Handle response
    print(res)

Parameters

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

Response

models.FolderDeleteFolderResponse

Errors

Error Type Status Code Content Type
models.FolderDeleteFolderBadRequestError 400 application/json
models.FolderDeleteFolderUnauthorizedError 401 application/json
models.FolderDeleteFolderForbiddenError 403 application/json
models.FolderDeleteFolderInternalServerError 500 application/json
models.APIError 4XX, 5XX */*