paperless-api 0.10.0

Async Paperless ngx API client
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

//! Types related to share links.

use std::sync::Arc;

use chrono::{DateTime, Utc};
use derive_more::Display;
use serde::{Deserialize, Serialize};

use paperless_api_macros::CreateDto;

/// The version of the file provided by a share link.
#[derive(Debug, Display, Default, Clone, Copy, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum ShareLinkFileVersion {
    /// The "current" file version in the paperless archive.
    /// This version might be modified by paperless.
    #[default]
    Archive,

    /// The original file version initially uploaded to paperless.
    Original,
}

/// A share link
#[derive(Debug, Clone, Deserialize, CreateDto)]
#[api_info(private, endpoint = "share_links")]
pub struct ShareLink {
    /// Unique identifier of the share link.
    #[dto(skip)]
    pub id: crate::id::ShareLinkId,

    /// Document of the share link.
    pub document: crate::id::DocumentId,

    /// When the share link was created.
    #[dto(skip)]
    pub created: DateTime<Utc>,

    /// When the share link expires.
    pub expiration: DateTime<Utc>,

    /// File version of the share link.
    pub file_version: ShareLinkFileVersion,

    /// Slug of the share link.
    #[dto(skip)]
    pub slug: String,

    #[serde(skip)]
    #[dto(skip)]
    pub(crate) base_url: Arc<str>,
}

impl ShareLink {
    #[must_use]
    pub fn url(&self) -> String {
        format!("{}/share/{}", self.base_url, self.slug)
    }
}