ovok_sdk.resources.documents

Stored documents: uploads, metadata and download links.

DocumentsResourceCopy Anchor Link

DocumentsResource(http: HttpClient, base_url: str)

List, upload, replace and delete stored documents, and build download URLs.

Created by Ovok; access it as ovok.documents.

list()Copy Anchor Link

list(params: QueryParams | None = None) -> Resource

List documents.

Parameters

Returns

• Resource: The API's list response.

create_upload()Copy Anchor Link

create_upload(body: Resource) -> Resource

Create a document and start its upload.

Parameters

Returns

• Resource: The created document, including where to upload the file.

replace_upload()Copy Anchor Link

replace_upload(document_id: str, body: Resource) -> Resource

Start an upload that replaces a document's file.

Parameters

Returns

• Resource: The document, including where to upload the new file.

update_metadata()Copy Anchor Link

update_metadata(document_id: str, body: Resource) -> Resource

Update a document's metadata without touching its file.

Parameters

Returns

• Resource: The updated document.

delete()Copy Anchor Link

delete(document_id: str) -> Resource

Delete a document.

Parameters

Returns

• Resource: The API's delete response.

download_url()Copy Anchor Link

download_url(document_id: str, params: QueryParams | None = None) -> str

Build the download URL of a document; no request is sent.

Parameters

Returns

• str: The absolute download URL.

public_download_url()Copy Anchor Link

public_download_url(public_token: str, params: QueryParams | None = None) -> str

Build the public download URL for a shared document; no request is sent.

Parameters

Returns

• str: The absolute download URL, usable without authentication.