wekan-cli 2.0.0

Agent-first, human-friendly command-line client for Wekan
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
use crate::client::metadata::*;
use serde::Serialize;
use serde_json::Number;

#[derive(Debug, Eq, PartialEq, Serialize)]
pub struct BotRunReport {
    pub run_id: String,
    pub status: BotRunStatus,
}

impl From<crate::client::cards::bot_runs::BotRunReport> for BotRunReport {
    fn from(report: crate::client::cards::bot_runs::BotRunReport) -> Self {
        Self {
            run_id: report.run_id,
            status: report.status.into(),
        }
    }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum BotRunStatus {
    Queued,
    Running,
    AwaitingInput,
    Review,
    Done,
    Failed,
    Stopped,
}

impl From<crate::client::cards::bot_runs::BotRunStatus> for BotRunStatus {
    fn from(status: crate::client::cards::bot_runs::BotRunStatus) -> Self {
        use crate::client::cards::bot_runs::BotRunStatus as WireStatus;
        match status {
            WireStatus::Queued => Self::Queued,
            WireStatus::Running => Self::Running,
            WireStatus::AwaitingInput => Self::AwaitingInput,
            WireStatus::Review => Self::Review,
            WireStatus::Done => Self::Done,
            WireStatus::Failed => Self::Failed,
            WireStatus::Stopped => Self::Stopped,
        }
    }
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum CardMembershipKind {
    Member,
    Assignee,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardMemberCollectionSuccess {
    pub board_id: String,
    pub list_id: String,
    pub card_id: String,
    pub members: Vec<String>,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardAssigneeCollectionSuccess {
    pub board_id: String,
    pub list_id: String,
    pub card_id: String,
    pub assignees: Vec<String>,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardMembershipMutationSuccess {
    pub board_id: String,
    pub list_id: String,
    pub card_id: String,
    pub user_id: String,
    pub kind: CardMembershipKind,
    pub action: super::MembershipAction,
    pub members: Vec<String>,
    pub assignees: Vec<String>,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardSummary {
    pub card_id: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub swimlane_id: Option<String>,
    pub received_at: Option<String>,
    pub start_at: Option<String>,
    pub due_at: Option<String>,
    pub end_at: Option<String>,
    pub assignees: Vec<String>,
    pub sort: Option<Number>,
}

#[derive(Debug, Eq, PartialEq, Serialize)]
pub struct CardCollectionSuccess {
    pub board_id: String,
    pub list_id: String,
    pub cards: Vec<CardSummary>,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
#[serde(untagged)]
pub enum CardDetailCustomFieldValue {
    String(String),
    Number(Number),
    Boolean(bool),
    Strings(Vec<Option<String>>),
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardDetailCustomField {
    pub custom_field_id: Option<String>,
    pub value: Option<CardDetailCustomFieldValue>,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum CardDetailStickerHighlight {
    Underline,
    Round,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardDetailSticker {
    pub icon: Option<String>,
    pub name: Option<String>,
    pub highlight: Option<CardDetailStickerHighlight>,
    pub position: Option<Number>,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardDetailLocation {
    pub location_id: String,
    pub name: Option<String>,
    pub address: Option<String>,
    pub latitude: Option<Number>,
    pub longitude: Option<Number>,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardDetailDependency {
    pub card_id: String,
    pub dependency_type: Option<String>,
    pub color: Option<String>,
    pub icon: Option<String>,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardDetailVote {
    pub question: String,
    pub positive: Vec<String>,
    pub negative: Vec<String>,
    pub end: Option<String>,
    pub public: bool,
    pub allow_non_board_members: bool,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardDetailPoker {
    pub question: Option<bool>,
    pub one: Vec<String>,
    pub two: Vec<String>,
    pub three: Vec<String>,
    pub five: Vec<String>,
    pub eight: Vec<String>,
    pub thirteen: Vec<String>,
    pub twenty: Vec<String>,
    pub forty: Vec<String>,
    pub one_hundred: Vec<String>,
    pub unsure: Vec<String>,
    pub end: Option<String>,
    pub allow_non_board_members: Option<bool>,
    pub estimation: Option<Number>,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardDetail {
    pub scrum: Option<Box<ScrumCard>>,
    pub drawings: Option<Vec<CardDrawing>>,
    pub custom_field_links: Option<Vec<CardCustomFieldLink>>,
    pub sync_last_source: Option<Box<CardSyncLastSource>>,
    pub email: Option<Box<CardEmail>>,

    pub scrum_revision: Option<serde_json::Number>,
    pub parent_ids: Option<Vec<String>>,
    pub map_x: Option<serde_json::Number>,
    pub map_y: Option<serde_json::Number>,
    pub column_set_values: Option<std::collections::BTreeMap<String, String>>,
    pub card_kind: Option<String>,
    pub last_recurrence_at: Option<String>,
    pub sync_source_key: Option<String>,
    pub sync_label_ids: Option<Vec<String>>,
    pub sync_issue_state: Option<String>,
    pub sync_closed_by_we_kan: Option<bool>,
    pub sync_external_id: Option<String>,
    pub sync_source_type: Option<String>,
    pub attached_card_ids: Option<Vec<String>>,
    pub flow_start_at: Option<String>,
    pub flow_user_id: Option<String>,
    pub pomodoro_start_at: Option<String>,
    pub pomodoro_phase: Option<String>,
    pub pomodoro_user_id: Option<String>,
    pub show_list_on_card: Option<bool>,
    pub checklists: Option<Vec<crate::client::checklists::ChecklistDocument>>,
    pub list_entered_at: Option<String>,
    pub recurrence_interval: Option<String>,
    pub last_move_reason: Option<String>,
    pub flow_interruptions: Option<Number>,
    pub pomodoro_count: Option<Number>,
    pub pomodoro_work_minutes: Option<Number>,
    pub card_id: String,
    pub title: Option<String>,
    pub watchers: Option<Vec<String>>,
    pub archived: bool,
    pub archived_at: Option<String>,
    pub deleted_at: Option<String>,
    pub deleted_by: Option<String>,
    pub delete_batch_id: Option<String>,
    pub parent_id: Option<String>,
    pub list_id: Option<String>,
    pub swimlane_id: String,
    pub board_id: Option<String>,
    pub cover_id: Option<String>,
    pub color: Option<String>,
    pub created_at: String,
    pub modified_at: String,
    pub custom_fields: Vec<CardDetailCustomField>,
    pub date_last_activity: String,
    pub description: Option<String>,
    pub requested_by: Option<String>,
    pub assigned_by: Option<String>,
    pub label_ids: Vec<Option<String>>,
    pub members: Vec<String>,
    pub assignees: Vec<String>,
    pub requesters: Vec<String>,
    pub assigners: Vec<String>,
    pub received_at: Option<String>,
    pub start_at: Option<String>,
    pub due_at: Option<String>,
    pub end_at: Option<String>,
    pub due_complete: Option<bool>,
    pub stickers: Vec<CardDetailSticker>,
    pub location_name: Option<String>,
    pub location_address: Option<String>,
    pub location_latitude: Option<Number>,
    pub location_longitude: Option<Number>,
    pub locations: Vec<CardDetailLocation>,
    pub spent_time: Option<Number>,
    pub is_overtime: Option<bool>,
    pub user_id: String,
    pub sort: Option<Number>,
    pub subtask_sort: Option<Number>,
    pub card_type: String,
    pub linked_id: Option<String>,
    pub card_dependencies: Vec<CardDetailDependency>,
    pub vote: Option<CardDetailVote>,
    pub poker: Option<CardDetailPoker>,
    pub target_id_gantt: Vec<String>,
    pub link_type_gantt: Vec<Number>,
    pub link_id_gantt: Vec<String>,
    pub card_number: Option<Number>,
    pub show_activities: bool,
    pub show_list_on_minicard: Option<bool>,
    pub show_checklist_at_minicard: Option<bool>,
    pub hide_finished_checklist_if_items_are_hidden: Option<bool>,
}

#[derive(Debug, Eq, PartialEq, Serialize)]
pub struct CardCreateSuccess {
    pub board_id: String,
    pub list_id: String,
    pub card_id: String,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum CardSubmittedField {
    Title,
    Sort,
    ParentId,
    Description,
    Color,
    LabelIds,
    RequestedBy,
    AssignedBy,
    ReceivedAt,
    StartAt,
    DueAt,
    EndAt,
    SpentTime,
    IsOverTime,
    Members,
    Assignees,
    DueComplete,
    SwimlaneId,
    ListId,
    NewBoardId,
    NewSwimlaneId,
    NewListId,
    MoveReason,
    Archive,
    Vote,
    Poker,
    CustomFields,
    Stickers,
    Locations,
}

#[derive(Debug, Eq, PartialEq, Serialize)]
pub struct CardUpdateSuccess {
    pub board_id: String,
    pub list_id: String,
    pub card_id: String,
    pub submitted_fields: Vec<CardSubmittedField>,
}

#[derive(Debug, Eq, PartialEq, Serialize)]
pub struct CardArchiveSuccess {
    pub board_id: String,
    pub list_id: String,
    pub card_id: String,
    pub archived: bool,
    pub archived_at: String,
}

#[derive(Debug, Eq, PartialEq, Serialize)]
pub struct CardRestoreSuccess {
    pub board_id: String,
    pub list_id: String,
    pub card_id: String,
    pub archived: bool,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum CardDeleteMode {
    Hard,
}

#[derive(Debug, Eq, PartialEq, Serialize)]
pub struct CardDeleteSuccess {
    pub board_id: String,
    pub list_id: String,
    pub card_id: String,
    pub deletion_requested: bool,
    pub delete_mode: CardDeleteMode,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardCustomFieldSetSuccess {
    pub board_id: String,
    pub list_id: String,
    pub card_id: String,
    pub custom_field_id: String,
    pub custom_fields: Vec<CardDetailCustomField>,
}
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardCustomFieldQuerySuccess {
    pub board_id: String,
    pub custom_field_id: String,
    pub value: String,
    pub cards: Vec<CardDetail>,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct CardLabelCollection {
    pub board_id: String,
    pub list_id: String,
    pub card_id: String,
    pub label_ids: Vec<Option<String>>,
}

#[derive(Debug, Eq, PartialEq, Serialize)]
pub struct CardCopySuccess {
    pub source_board_id: String,
    pub source_list_id: String,
    pub source_card_id: String,
    pub target_board_id: String,
    pub target_list_id: String,
    pub target_swimlane_id: String,
    pub card_id: String,
}
#[derive(Debug, Eq, PartialEq, Serialize)]
pub struct CardCountSuccess {
    pub board_id: String,
    pub list_id: Option<String>,
    pub count: u64,
}
#[derive(Debug, Eq, PartialEq, Serialize)]
pub struct SwimlaneCardCollectionSuccess {
    pub board_id: String,
    pub swimlane_id: String,
    pub cards: Vec<SwimlaneCardSummary>,
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct SwimlaneCardSummary {
    pub card_id: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub list_id: Option<String>,
    pub received_at: Option<String>,
    pub start_at: Option<String>,
    pub due_at: Option<String>,
    pub end_at: Option<String>,
    pub assignees: Option<Vec<Option<String>>>,
    pub sort: Option<Number>,
}