tftio-asana-cli 3.1.0

An interface to the Asana API
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

//! User-centric data structures consumed by the CLI.

use super::{project::MemberPermission, workspace::WorkspaceReference};
use serde::{Deserialize, Serialize};

/// Lightweight user reference returned by Asana APIs.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Hash)]
pub struct UserReference {
    /// Globally unique identifier.
    pub gid: String,
    /// Human friendly display name.
    #[serde(default)]
    pub name: Option<String>,
    /// Resource type reported by Asana.
    #[serde(default)]
    pub resource_type: Option<String>,
    /// Optional primary email address when included in the response.
    #[serde(default)]
    pub email: Option<String>,
}

impl UserReference {
    /// Convenience helper displaying either the name or email.
    #[must_use]
    pub fn label(&self) -> String {
        self.name
            .clone()
            .or_else(|| self.email.clone())
            .unwrap_or_else(|| self.gid.clone())
    }
}

/// Identity payload used when specifying members in API requests.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Hash)]
pub struct UserIdentity {
    /// Accept both email addresses and gids per Asana API contract.
    pub resource: String,
    /// Optional role/permission hint.
    #[serde(default)]
    pub role: Option<MemberPermission>,
}

/// User photo URLs at different sizes.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
#[allow(
    clippy::struct_field_names,
    reason = "field names mirror the Asana API JSON keys; renaming to satisfy the lint would break serde mapping"
)]
pub struct UserPhoto {
    /// 21x21 pixel image URL.
    #[serde(rename = "image_21x21")]
    #[serde(default)]
    pub image_21x21: Option<String>,
    /// 27x27 pixel image URL.
    #[serde(rename = "image_27x27")]
    #[serde(default)]
    pub image_27x27: Option<String>,
    /// 36x36 pixel image URL.
    #[serde(rename = "image_36x36")]
    #[serde(default)]
    pub image_36x36: Option<String>,
    /// 60x60 pixel image URL.
    #[serde(rename = "image_60x60")]
    #[serde(default)]
    pub image_60x60: Option<String>,
    /// 128x128 pixel image URL.
    #[serde(rename = "image_128x128")]
    #[serde(default)]
    pub image_128x128: Option<String>,
}

/// Full user payload.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub struct User {
    /// Globally unique identifier.
    pub gid: String,
    /// User's name.
    pub name: String,
    /// Email address.
    #[serde(default)]
    pub email: Option<String>,
    /// Resource type marker.
    #[serde(default)]
    pub resource_type: Option<String>,
    /// Photo URLs.
    #[serde(default)]
    pub photo: Option<UserPhoto>,
    /// Workspaces user is member of.
    #[serde(default)]
    pub workspaces: Vec<WorkspaceReference>,
}

/// Parameters for listing users in a workspace.
#[derive(Debug, Clone)]
pub struct UserListParams {
    /// Workspace identifier.
    pub workspace_gid: String,
    /// Maximum number to fetch.
    pub limit: Option<usize>,
}