chorus 0.20.0

A library for interacting with multiple Spacebar-compatible Instances at once.
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

use reqwest::Client;
use serde_json::to_string;

use crate::{
    errors::ChorusResult,
    instance::ChorusUser,
    ratelimiter::ChorusRequest,
    types::{
        self, BulkRemoveRelationshipsQuery, CreateUserRelationshipSchema, FriendRequestSendSchema,
        LimitType, RelationshipType, Snowflake,
    },
};

impl ChorusUser {
    /// Retrieves a list of mutual friends between the authenticated user and a given user.
    ///
    /// # Reference
    /// See <https://luna.gitlab.io/discord-unofficial-docs/docs/relationships.html#get-userspeer_idrelationships>
    pub async fn get_mutual_relationships(
        &mut self,
        user_id: Snowflake,
    ) -> ChorusResult<Vec<types::PublicUser>> {
        let url = format!(
            "{}/users/{}/relationships",
            self.belongs_to.read().unwrap().urls.api,
            user_id
        );
        let chorus_request = ChorusRequest {
            request: Client::new().get(url),
            limit_type: LimitType::Global,
        }
        .with_headers_for(self);
        chorus_request
            .send_and_deserialize_response::<Vec<types::PublicUser>>(self)
            .await
    }

    /// Retrieves the user's relationships.
    ///
    /// # Reference
    /// See <https://luna.gitlab.io/discord-unofficial-docs/docs/relationships.html#get-usersmerelationships>
    pub async fn get_relationships(&mut self) -> ChorusResult<Vec<types::Relationship>> {
        let url = format!(
            "{}/users/@me/relationships",
            self.belongs_to.read().unwrap().urls.api
        );
        let chorus_request = ChorusRequest {
            request: Client::new().get(url),
            limit_type: LimitType::Global,
        }
        .with_headers_for(self);
        chorus_request
            .send_and_deserialize_response::<Vec<types::Relationship>>(self)
            .await
    }

    /// Sends a friend request to a user.
    ///
    /// # Reference
    /// See <https://luna.gitlab.io/discord-unofficial-docs/docs/relationships.html#post-usersmerelationships>
    pub async fn send_friend_request(
        &mut self,
        schema: FriendRequestSendSchema,
    ) -> ChorusResult<()> {
        let url = format!(
            "{}/users/@me/relationships",
            self.belongs_to.read().unwrap().urls.api
        );
        let chorus_request = ChorusRequest {
            request: Client::new().post(url).json(&schema),
            limit_type: LimitType::Global,
        }
        .with_headers_for(self);
        chorus_request.send_and_handle_as_result(self).await
    }

    /// Modifies the relationship between the authenticated user and a given user.
    ///
    /// Can be used to unfriend users, accept or send friend requests and block or unblock users.
    pub async fn modify_user_relationship(
        &mut self,
        user_id: Snowflake,
        relationship_type: RelationshipType,
    ) -> ChorusResult<()> {
        let api_url = self.belongs_to.read().unwrap().urls.api.clone();
        match relationship_type {
            RelationshipType::None => {
                let chorus_request = ChorusRequest {
                    request: Client::new()
                        .delete(format!("{}/users/@me/relationships/{}", api_url, user_id)),
                    limit_type: LimitType::Global,
                }
                .with_headers_for(self);
                chorus_request.send_and_handle_as_result(self).await
            }
            RelationshipType::Friends | RelationshipType::Incoming | RelationshipType::Outgoing => {
                let schema = CreateUserRelationshipSchema {
                    relationship_type: None, // Selecting 'None' here will accept an incoming FR or send a new FR.
                    from_friend_suggestion: None,
                    friend_token: None,
                };
                let chorus_request = ChorusRequest {
                    request: Client::new()
                        .put(format!("{}/users/@me/relationships/{}", api_url, user_id))
                        .json(&schema),
                    limit_type: LimitType::Global,
                }
                .with_headers_for(self);
                chorus_request.send_and_handle_as_result(self).await
            }
            RelationshipType::Blocked => {
                let schema = CreateUserRelationshipSchema {
                    relationship_type: Some(RelationshipType::Blocked),
                    from_friend_suggestion: None,
                    friend_token: None,
                };
                let chorus_request = ChorusRequest {
                    request: Client::new()
                        .put(format!("{}/users/@me/relationships/{}", api_url, user_id))
                        .json(&schema),
                    limit_type: LimitType::Global,
                }
                .with_headers_for(self);
                chorus_request.send_and_handle_as_result(self).await
            }
            RelationshipType::Suggestion | RelationshipType::Implicit => Ok(()),
        }
    }

    /// Removes the relationship between the authenticated user and a given user.
    ///
    /// # Reference
    /// See <https://luna.gitlab.io/discord-unofficial-docs/docs/relationships.html#delete-usersmerelationshipspeer_id>
    pub async fn remove_relationship(&mut self, user_id: Snowflake) -> ChorusResult<()> {
        let url = format!(
            "{}/users/@me/relationships/{}",
            self.belongs_to.read().unwrap().urls.api,
            user_id
        );
        let chorus_request = ChorusRequest {
            request: Client::new().delete(url),
            limit_type: LimitType::Global,
        }
        .with_headers_for(self);
        chorus_request.send_and_handle_as_result(self).await
    }

    /// Removes multiple relationships.
    ///
    /// # Reference
    /// See <https://docs.discord.food/resources/relationships#bulk-remove-relationships>
    pub async fn bulk_remove_relationships(
        &mut self,
        query: Option<BulkRemoveRelationshipsQuery>,
    ) -> ChorusResult<()> {
        let query_parameters = if let Some(passed) = query {
            passed.to_query()
        } else {
            Vec::new()
        };

        let url = format!(
            "{}/users/@me/relationships",
            self.belongs_to.read().unwrap().urls.api,
        );
        let chorus_request = ChorusRequest {
            request: Client::new().delete(url).query(&query_parameters),
            limit_type: LimitType::Global,
        }
        .with_headers_for(self);
        chorus_request.send_and_handle_as_result(self).await
    }

    /// [Ignores](https://support.discord.com/hc/en-us/articles/28084948873623-How-to-Ignore-Users-on-Discord) a user.
    ///
    /// # Notes
    /// As of 2025/03/16, Spacebar does not yet implement this endpoint.
    ///
    /// # Reference
    /// See <https://docs.discord.food/resources/relationships#ignore-user>
    pub async fn ignore_user(&mut self, user_id: Snowflake) -> ChorusResult<()> {
        let url = format!(
            "{}/users/@me/relationships/{}/ignore",
            self.belongs_to.read().unwrap().urls.api,
            user_id
        );

        let chorus_request = ChorusRequest {
            request: Client::new().put(url),
            limit_type: LimitType::Global,
        }
        .with_headers_for(self);

        chorus_request.send_and_handle_as_result(self).await
    }

    /// [Unignores](https://support.discord.com/hc/en-us/articles/28084948873623-How-to-Ignore-Users-on-Discord) a user.
    ///
    /// # Notes
    /// As of 2025/03/16, Spacebar does not yet implement this endpoint.
    ///
    /// # Reference
    /// See <https://docs.discord.food/resources/relationships#unignore-user>
    pub async fn unignore_user(&mut self, user_id: Snowflake) -> ChorusResult<()> {
        let url = format!(
            "{}/users/@me/relationships/{}/ignore",
            self.belongs_to.read().unwrap().urls.api,
            user_id
        );

        let chorus_request = ChorusRequest {
            request: Client::new().delete(url),
            limit_type: LimitType::Global,
        }
        .with_headers_for(self);

        chorus_request.send_and_handle_as_result(self).await
    }
}