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

//! Types related to document types.

use serde::{Deserialize, Serialize};

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

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

/// A document type.
#[derive(Debug, Clone, Deserialize, Serialize, CreateDto, UpdateDto, Item)]
pub struct DocumentType {
    /// Unique identifier of the document type.
    #[dto(skip)]
    pub id: crate::id::DocumentTypeId,

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

    /// Name of the document type.
    pub name: String,

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

    /// Matching algorithm for the document type.
    pub matching_algorithm: MatchAlgorithm,

    /// Whether the document type matching is case-insensitive.
    pub is_insensitive: Option<bool>,

    /// Number of documents with this type.
    #[dto(skip)]
    #[serde(default)]
    pub document_count: u32,

    /// Owner of the document type.
    pub owner: Option<crate::id::UserId>,

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