rusty_dropbox_sdk 0.8.2

Unofficial SDK for dropbox in Rust
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

pub mod properties_add;
pub mod properties_overwrite;
pub mod properties_remove;
pub mod properties_search;
pub mod properties_search_continue;
pub mod properties_update;
pub mod templates_add_for_user;
pub mod templates_get_for_user;
pub mod templates_list_for_user;
pub mod templates_remove_for_user;
pub mod templates_update_for_user;

use serde::{Deserialize, Serialize};

// =============================================================================
// Type names follow the Dropbox Stone spec
// (`dropbox-api-spec/file_properties.stone`).
// =============================================================================

#[derive(Serialize, Deserialize, Debug)]
pub struct PropertyField {
    pub name: String,
    pub value: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct PropertyGroup {
    pub fields: Vec<PropertyField>,
    pub template_id: String,
}

/// `AddPropertiesArg` and `OverwritePropertyGroupArg` have identical wire
/// shape per spec; Dropbox names them separately for documentation. Both
/// names are exposed via a type alias.
#[derive(Serialize, Deserialize, Debug)]
pub struct AddPropertiesArg {
    pub path: String,
    pub property_groups: Vec<PropertyGroup>,
}

pub type OverwritePropertyGroupArg = AddPropertiesArg;

#[derive(Serialize, Deserialize, Debug)]
pub struct RemovePropertiesArg {
    pub path: String,
    pub property_template_ids: Vec<String>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct PropertiesSearchMode {
    #[serde(rename = ".tag")]
    pub tag: String,
    pub field_name: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct PropertiesSearchQuery {
    pub logical_operator: String,
    pub mode: PropertiesSearchMode,
    pub query: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct PropertiesSearchArg {
    pub queries: Vec<PropertiesSearchQuery>,
    pub template_filter: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct PropertiesSearchMatch {
    pub id: String,
    pub is_deleted: bool,
    pub path: String,
    pub property_groups: Vec<PropertyGroup>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct PropertiesSearchResult {
    pub matches: Vec<PropertiesSearchMatch>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct PropertiesSearchContinueArg {
    pub cursor: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct PropertyGroupUpdate {
    pub add_or_update_fields: Vec<PropertyField>,
    pub remove_fields: Vec<String>,
    pub template_id: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct UpdatePropertiesArg {
    pub path: String,
    pub update_property_groups: Vec<PropertyGroupUpdate>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct PropertyFieldTemplate {
    pub description: String,
    pub name: String,
    #[serde(rename = "type")]
    pub field_type: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct AddTemplateArg {
    pub description: String,
    pub fields: Vec<PropertyFieldTemplate>,
    pub name: String,
}

/// Wire shape `{".tag": "string"}`. The tag-only union has one named
/// variant in spec (`string`); modelled as a struct for forward compat.
#[derive(Serialize, Deserialize, Debug)]
pub struct PropertyType {
    #[serde(rename = ".tag")]
    pub tag: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct PropertyFieldTemplateTagged {
    pub description: String,
    pub name: String,
    #[serde(rename = "type")]
    pub field_type: PropertyType,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct GetTemplateResult {
    pub description: String,
    pub fields: Vec<PropertyFieldTemplateTagged>,
    pub name: String,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct ListTemplateResult {
    pub template_ids: Vec<String>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct AddTemplateResult {
    pub template_id: String,
}

pub type UpdateTemplateResult = AddTemplateResult;

#[derive(Serialize, Deserialize, Debug)]
pub struct GetTemplateArg {
    pub template_id: String,
}

pub type RemoveTemplateArg = GetTemplateArg;

#[derive(Serialize, Deserialize, Debug)]
pub struct UpdateTemplateArg {
    pub add_fields: Vec<PropertyFieldTemplate>,
    pub description: String,
    pub name: String,
    pub template_id: String,
}