Struct PaperlessClient 

pub struct PaperlessClient { /* private fields */ }

Client to interact with Paperless.

Implementations

impl PaperlessClient

pub fn new( base_url: &str, token: &str, headers: Option<&HashMap<String, String>>, ) -> Result<Self, String>

Create a new Paperless client.

pub async fn refresh( &mut self, data: impl IntoIterator<Item = RefreshData>, ) -> Result<(), Error>

Refresh selected cached metadata concurrently.

pub async fn refresh_tags(&mut self) -> Result<(), Error>

List all tags.

pub async fn refresh_custom_fields(&mut self) -> Result<(), Error>

List all custom fields.

pub async fn refresh_correspondents(&mut self) -> Result<(), Error>

List all correspondents.

pub async fn refresh_document_types(&mut self) -> Result<(), Error>

List all document types.

pub async fn get_documents_by_tags( &self, tag_ids: &[TagId], truncate_content: bool, ) -> Result<Vec<Document>, Error>

Get all documents with any of the given tags.

pub async fn get_document_by_id( &self, id: DocumentId, ) -> Result<Document, Error>

Get a document by its ID.

pub async fn get_task_status( &self, task_id: Option<&TaskId>, task_name: Option<&str>, acknowledged: Option<bool>, ) -> Result<Vec<Task>, Error>

Get all tasks with optional filtering by ID, name, or acknowledged status.

pub async fn upload_document( &self, file_path: &Path, filename: &str, ) -> Result<TaskId, Error>

Upload a document to Paperless.

Returns the task ID on success.

pub fn tags(&self) -> &HashMap<TagId, Tag>

pub fn find_tag_by_name(&self, name: &str) -> Option<&Tag>

pub fn document_types(&self) -> &HashMap<DocumentTypeId, DocumentType>

pub fn correspondents(&self) -> &HashMap<CorrespondentId, Correspondent>

pub fn custom_fields(&self) -> &HashMap<CustomFieldId, CustomField>

pub fn find_custom_field_by_name(&self, name: &str) -> Option<&CustomField>

Trait Implementations

impl Clone for PaperlessClient

fn clone(&self) -> PaperlessClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PaperlessClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.