paperless-rs 0.1.0

An asynchronous Rust library for the Paperless-ngx document manager
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

use crate::utils::pagination::Response;
use crate::utils::Field;
use crate::{ternary, PaperlessClient};
use reqwest::Method;
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Clone, Debug, Default)]
pub struct Document {
    pub id: u64,
    pub title: String,
    pub content: String,

    pub tags: Vec<String>,
    pub document_type: Option<String>,
    pub correspondent: Option<String>,

    pub created: String,
    pub created_date: Option<String>,
    pub modified: Option<String>,
    pub added: String,

    pub archive_serial_number: Option<String>,
    pub original_file_name: String,
    pub archived_file_name: Option<String>,

    pub notes: Vec<String>,
    //TODO: Add permissions
    pub custom_fields: Vec<Field>,
}

#[derive(Serialize, Deserialize, Debug, Default)]
pub struct Metadata {
    pub original_checksum: String,
    pub original_size: String,
    pub original_mime_type: String,
    pub media_filename: String,
    pub has_archive_version: bool,
    pub original_metadata: Vec<Field>,

    pub archive_checksum: Option<String>,
    pub archive_size: Option<String>,
    pub archive_metadata: Option<String>,
}

impl PaperlessClient {
    pub async fn fetch_documents(
        &mut self,
    ) -> Result<Response<Document>, Box<dyn std::error::Error>> {
        let url = format!("{}/documents/", self.base_url);

        let request_builder = self.prepare_endpoint(Method::GET, url).await?;
        self.call_endpoint(request_builder).await
    }

    pub async fn download_document(
        &mut self,
        document_id: u64,
        original: bool,
    ) -> Result<Document, Box<dyn std::error::Error>> {
        let url = format!("{}/documents/{}/download/", self.base_url, document_id);
        let query_url = format!("{}{}", url, ternary!(original, "?original=true", ""));

        let request_builder = self.prepare_endpoint(Method::GET, query_url).await?;
        self.call_endpoint(request_builder).await
    }

    pub async fn preview_document(
        &mut self,
        document_id: u64,
        original: bool,
    ) -> Result<String, Box<dyn std::error::Error>> {
        let url = format!("{}/documents/{}/preview/", self.base_url, document_id);
        let query_url = format!("{}{}", url, ternary!(original, "?original=true", ""));

        let request_builder = self.prepare_endpoint(Method::GET, query_url).await?;
        self.call_endpoint(request_builder).await
    }

    pub async fn fetch_document_thumbnail(
        &mut self,
        document_id: u64,
    ) -> Result<String, Box<dyn std::error::Error>> {
        let url = format!("{}/documents/{}/thumb/", self.base_url, document_id);

        let request_builder = self.prepare_endpoint(Method::GET, url).await?;
        self.call_endpoint(request_builder).await
    }

    pub async fn fetch_document_metadata(
        &mut self,
        document_id: u64,
    ) -> Result<Metadata, Box<dyn std::error::Error>> {
        let url = format!("{}/documents/{}/metadata/", self.base_url, document_id);

        let request_builder = self.prepare_endpoint(Method::GET, url).await?;
        self.call_endpoint(request_builder).await
    }

    pub async fn fetch_document_notes(
        &mut self,
        document_id: u64,
    ) -> Result<Vec<String>, Box<dyn std::error::Error>> {
        let url = format!("{}/documents/{}/notes/", self.base_url, document_id);

        let request_builder = self.prepare_endpoint(Method::GET, url).await?;
        self.call_endpoint(request_builder).await
    }

    pub async fn fetch_document_share_links(
        &mut self,
        document_id: u64,
    ) -> Result<Vec<String>, Box<dyn std::error::Error>> {
        let url = format!("{}/documents/{}/share-links/", self.base_url, document_id);

        let request_builder = self.prepare_endpoint(Method::GET, url).await?;
        self.call_endpoint(request_builder).await
    }
}