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

use serde::{Deserialize, Serialize};

use crate::id::{CustomFieldId, SelectableOptionId};

/// Custom field definition.
#[derive(Debug, Clone, Deserialize)]
pub struct CustomField {
    /// Unique identifier of the custom field.
    pub id: CustomFieldId,

    /// Name of the custom field.
    pub name: String,

    /// Data type of the custom field.
    pub data_type: String,

    pub extra_data: Option<CustomFieldExtraData>,
}

/// Custom field value of an existing document
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct DocumentCustomField {
    /// Unique identifier of the custom field.
    pub field: CustomFieldId,

    /// Value of the custom field.
    pub value: String,
}

#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct CustomFieldExtraData {
    pub default_currency: Option<String>,
    pub select_options: Option<Vec<SelectableOption>>,
}

#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct SelectableOption {
    pub id: SelectableOptionId,
    pub label: String,
}