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
use crate::{
api::service::QobuzApiService,
errors::QobuzApiError::{self, QobuzApiInitializationError},
models::{QobuzApiStatusResponse, UserFavorites, UserFavoritesIds},
};
impl QobuzApiService {
/// Add tracks, albums & artists to the authenticated user's favorites.
/// At least 1 type of favorite to add is required as parameter.
///
/// # Arguments
/// * `track_ids` - IDs of the tracks to add, comma separated list (optional)
/// * `album_ids` - IDs of the albums to add, comma separated list (optional)
/// * `artist_ids` - IDs of the artists to add, comma separated list (optional)
///
/// # Returns
/// * `Ok(QobuzApiStatusResponse)` - Response indicating if the request was successful
/// * `Err(QobuzApiError)` - If the API request fails
///
/// # Example
/// ```rust,no_run
/// # use qobuz_api_rust::QobuzApiService;
/// # use tokio;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # let service = QobuzApiService::new().await?;
/// // Add a track to favorites
/// let response = service.add_user_favorites(
/// Some("123456789"),
/// None,
/// None,
/// ).await?;
/// # Ok(())
/// # }
/// ```
pub async fn add_user_favorites(
&self,
track_ids: Option<&str>,
album_ids: Option<&str>,
artist_ids: Option<&str>,
) -> Result<QobuzApiStatusResponse, QobuzApiError> {
let mut params = Vec::new();
if let Some(ids) = track_ids {
params.push(("track_ids".to_string(), ids.to_string()));
}
if let Some(ids) = album_ids {
params.push(("album_ids".to_string(), ids.to_string()));
}
if let Some(ids) = artist_ids {
params.push(("artist_ids".to_string(), ids.to_string()));
}
// At least one type of favorite must be provided
if params.is_empty() {
return Err(QobuzApiInitializationError {
message: "At least one type of favorite (track_ids, album_ids, or artist_ids) must be provided".to_string(),
});
}
self.signed_get("/favorite/create", ¶ms).await
}
/// Removes tracks, albums & artists from the authenticated user's favorites.
/// At least 1 type of favorite to remove is required as parameter.
///
/// # Arguments
/// * `track_ids` - IDs of the tracks to remove, comma separated list (optional)
/// * `album_ids` - IDs of the albums to remove, comma separated list (optional)
/// * `artist_ids` - IDs of the artists to remove, comma separated list (optional)
///
/// # Returns
/// * `Ok(QobuzApiStatusResponse)` - Response indicating if the request was successful
/// * `Err(QobuzApiError)` - If the API request fails
///
/// # Example
/// ```rust,no_run
/// # use qobuz_api_rust::QobuzApiService;
/// # use tokio;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # let service = QobuzApiService::new().await?;
/// // Remove a track from favorites
/// let response = service.delete_user_favorites(
/// Some("123456789"),
/// None,
/// None,
/// ).await?;
/// # Ok(())
/// # }
/// ```
pub async fn delete_user_favorites(
&self,
track_ids: Option<&str>,
album_ids: Option<&str>,
artist_ids: Option<&str>,
) -> Result<QobuzApiStatusResponse, QobuzApiError> {
let mut params = Vec::new();
if let Some(ids) = track_ids {
params.push(("track_ids".to_string(), ids.to_string()));
}
if let Some(ids) = album_ids {
params.push(("album_ids".to_string(), ids.to_string()));
}
if let Some(ids) = artist_ids {
params.push(("artist_ids".to_string(), ids.to_string()));
}
// At least one type of favorite must be provided
if params.is_empty() {
return Err(QobuzApiInitializationError {
message: "At least one type of favorite (track_ids, album_ids, or artist_ids) must be provided".to_string(),
});
}
self.signed_get("/favorite/delete", ¶ms).await
}
/// Gets the IDs of the user favorites for the authenticated user or user with the specified user ID.
///
/// # Arguments
/// * `user_id` - The User ID to fetch the favorites from. If omitted, returns favorites of the logged in user using user_auth_token (optional)
/// * `limit` - The maximum number of extra results to return. Defaults to 5000, minimum 1, maximum 99999 (optional)
/// * `offset` - The offset of the first extra result to return. Defaults to 0 (optional)
///
/// # Returns
/// * `Ok(UserFavoritesIds)` - The IDs of the user favorites
/// * `Err(QobuzApiError)` - If the API request fails
///
/// # Example
/// ```rust,no_run
/// # use qobuz_api_rust::QobuzApiService;
/// # use tokio;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # let service = QobuzApiService::new().await?;
/// // Get favorite IDs with default parameters
/// let favorites = service.get_user_favorite_ids(None, None, None).await?;
///
/// // Get favorite IDs with custom parameters
/// let favorites = service.get_user_favorite_ids(
/// Some("123456789"),
/// Some(100),
/// Some(50),
/// ).await?;
/// # Ok(())
/// # }
/// ```
pub async fn get_user_favorite_ids(
&self,
user_id: Option<&str>,
limit: Option<i32>,
offset: Option<i32>,
) -> Result<UserFavoritesIds, QobuzApiError> {
let mut params = Vec::new();
if let Some(id) = user_id {
params.push(("user_id".to_string(), id.to_string()));
}
params.push(("limit".to_string(), limit.unwrap_or(5000).to_string()));
params.push(("offset".to_string(), offset.unwrap_or(0).to_string()));
self.signed_get("/favorite/getUserFavoriteIds", ¶ms)
.await
}
/// Gets user favorites of the authenticated user or user with the specified user ID.
///
/// # Arguments
/// * `user_id` - The User ID to fetch the favorites from. If omitted, returns favorites of the logged in user using user_auth_token (optional)
/// * `type_param` - Type of favorites to include in the response (optional). Possible values are 'tracks', 'albums', 'artists' & 'articles'. If no type defined, all types are returned
/// * `limit` - The maximum number of extra results to return. Defaults to 50, minimum 1, maximum 500 (optional)
/// * `offset` - The offset of the first extra result to return. Defaults to 0 (optional)
///
/// # Returns
/// * `Ok(UserFavorites)` - The user favorites
/// * `Err(QobuzApiError)` - If the API request fails
///
/// # Example
/// ```rust,no_run
/// # use qobuz_api_rust::QobuzApiService;
/// # use tokio;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # let service = QobuzApiService::new().await?;
/// // Get all favorite types with default parameters
/// let favorites = service.get_user_favorites(None, None, None, None).await?;
///
/// // Get only favorite albums with custom parameters
/// let album_favorites = service.get_user_favorites(
/// None,
/// Some("albums"),
/// Some(100),
/// Some(20),
/// ).await?;
/// # Ok(())
/// # }
/// ```
pub async fn get_user_favorites(
&self,
user_id: Option<&str>,
type_param: Option<&str>,
limit: Option<i32>,
offset: Option<i32>,
) -> Result<UserFavorites, QobuzApiError> {
let mut params = Vec::new();
if let Some(id) = user_id {
params.push(("user_id".to_string(), id.to_string()));
}
if let Some(t) = type_param {
params.push(("type".to_string(), t.to_string()));
}
params.push(("limit".to_string(), limit.unwrap_or(50).to_string()));
params.push(("offset".to_string(), offset.unwrap_or(0).to_string()));
self.signed_get("/favorite/getUserFavorites", ¶ms).await
}
}