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

//! Endpoints for user profiles.

/// [GET /_matrix/client/r0/profile/{userId}/displayname](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-profile-userid-displayname)
pub mod get_display_name {
    use ruma_api_macros::ruma_api;
    use ruma_identifiers::UserId;

    ruma_api! {
        metadata {
            description: "Get the display name of a user.",
            method: GET,
            name: "get_display_name",
            path: "/_matrix/client/r0/profile/:user_id/displayname",
            rate_limited: false,
            requires_authentication: false,
        }

        request {
            /// The user whose display name will be retrieved.
            #[ruma_api(path)]
            pub user_id: UserId
        }

        response {
            /// The user's display name, if set.
            #[serde(skip_serializing_if = "Option::is_none")]
            pub displayname: Option<String>
        }
    }
}

/// [PUT /_matrix/client/r0/profile/{userId}/displayname](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-profile-userid-displayname)
pub mod set_display_name {
    use ruma_api_macros::ruma_api;
    use ruma_identifiers::UserId;

    ruma_api! {
        metadata {
            description: "Set the display name of the user.",
            method: PUT,
            name: "set_display_name",
            path: "/_matrix/client/r0/profile/:user_id/displayname",
            rate_limited: true,
            requires_authentication: true,
        }

        request {
            /// The new display name for the user.
            #[serde(skip_serializing_if = "Option::is_none")]
            pub displayname: Option<String>,
            /// The user whose display name will be set.
            #[ruma_api(path)]
            pub user_id: UserId,
        }

        response {}
    }
}

/// [GET /_matrix/client/r0/profile/{userId}/avatar_url](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-profile-userid-avatar-url)
pub mod get_avatar_url {
    use ruma_api_macros::ruma_api;
    use ruma_identifiers::UserId;

    ruma_api! {
        metadata {
            description: "Get the avatar URL of a user.",
            method: GET,
            name: "get_avatar_url",
            path: "/_matrix/client/r0/profile/:user_id/avatar_url",
            rate_limited: false,
            requires_authentication: false,
        }

        request {
            /// The user whose avatar URL will be retrieved.
            #[ruma_api(path)]
            pub user_id: UserId
        }

        response {
            /// The user's avatar URL, if set.
            #[serde(skip_serializing_if = "Option::is_none")]
            pub avatar_url: Option<String>
        }
    }
}

/// [PUT /_matrix/client/r0/profile/{userId}/avatar_url](https://matrix.org/docs/spec/client_server/r0.2.0.html#put-matrix-client-r0-profile-userid-avatar-url)
pub mod set_avatar_url {
    use ruma_api_macros::ruma_api;
    use ruma_identifiers::UserId;

    ruma_api! {
        metadata {
            description: "Set the avatar URL of the user.",
            method: PUT,
            name: "set_avatar_url",
            path: "/_matrix/client/r0/profile/:user_id/avatar_url",
            rate_limited: true,
            requires_authentication: true,
        }

        request {
            /// The new avatar URL for the user.
            pub avatar_url: String,
            /// The user whose avatar URL will be set.
            #[ruma_api(path)]
            pub user_id: UserId
        }

        response {}
    }
}

/// [GET /_matrix/client/r0/profile/{userId}](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-profile-userid)
pub mod get_profile {
    use ruma_api_macros::ruma_api;
    use ruma_identifiers::UserId;

    ruma_api! {
        metadata {
            description: "Get all profile information of an user.",
            method: GET,
            name: "get_profile",
            path: "/_matrix/client/r0/profile/:user_id",
            rate_limited: false,
            requires_authentication: false,
        }

        request {
            /// The user whose profile will be retrieved.
            #[ruma_api(path)]
            pub user_id: UserId,
        }

        response {
            /// The user's avatar URL, if set.
            #[serde(skip_serializing_if = "Option::is_none")]
            pub avatar_url: Option<String>,
            /// The user's display name, if set.
            #[serde(skip_serializing_if = "Option::is_none")]
            pub displayname: Option<String>,
        }
    }
}