paperless-api 0.8.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

//! Types related to correspondents.

use serde::{Deserialize, Serialize};

use paperless_api_macros::{CreateDto, Item, UpdateDto};

use super::MatchAlgorithm;
use super::permission::ItemPermissions;

/// A correspondent
#[derive(Debug, Default, Clone, Deserialize, Serialize, CreateDto, UpdateDto, Item)]
#[api_info(endpoint = "correspondents")]
pub struct Correspondent {
    /// Unique identifier of the correspondent.
    #[dto(skip)]
    pub id: crate::id::CorrespondentId,

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

    /// Name of the correspondent.
    pub name: String,

    /// Matching pattern for the tag.
    #[serde(rename = "match")]
    pub match_pattern: String,

    /// Matching algorithm for the tag.
    pub matching_algorithm: MatchAlgorithm,

    /// Whether the tag matching is case-insensitive.
    pub is_insensitive: bool,

    /// The number of documents associated with this correspondent.
    #[dto(skip)]
    #[serde(default)]
    pub document_count: u32,

    /// The user who owns this correspondent, if any.
    #[dto(skip)]
    pub owner: Option<crate::id::UserId>,

    /// The permissions for this correspondent.
    #[dto(skip)]
    #[serde(flatten)]
    pub permissions: ItemPermissions,
}