tidlers 0.1.1

A Rust library for interacting with the TIDAL music streaming 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
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

use crate::{
    client::{
        TidalClient,
        models::{
            collection::{PlaylistCollectionItem, SharingLevel},
            playlist::{
                PlaylistInfo, PlaylistItemsResponse, PlaylistsResponse, PublicUserPlaylistsResponse,
            },
        },
    },
    error::TidalError,
    ids::PlaylistId,
};

impl TidalClient {
    /// Creates a new playlist in the user's collection
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use tidlers::TidalClient;
    /// # use tidlers::auth::init::TidalAuth;
    /// # use tidlers::client::models::collection::SharingLevel;
    /// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// # let auth = TidalAuth::with_oauth();
    /// # let client = TidalClient::new(&auth);
    /// let playlist = client.create_playlist(
    ///     "My Playlist",
    ///     "A cool playlist",
    ///     Some(SharingLevel::Private),
    ///     None
    /// ).await?;
    /// println!("Created playlist: {}", playlist.data.title);
    /// # Ok(())
    /// # }
    /// ```
    pub async fn create_playlist(
        &self,
        title: impl Into<String>,
        description: impl Into<String>,
        sharing_level: Option<SharingLevel>,
        parent_id: Option<String>,
    ) -> Result<PlaylistCollectionItem, TidalError> {
        self.request(
            reqwest::Method::PUT,
            "/my-collection/playlists/folders/create-playlist",
        )
        .with_country_code()
        .with_param("name", title.into())
        .with_param("description", description.into())
        .with_param("folderId", parent_id.unwrap_or("root".to_string()))
        .with_param(
            "isPublic",
            (sharing_level.unwrap_or(SharingLevel::Private) == SharingLevel::Public).to_string(),
        )
        .with_base_url(Self::API_V2_LOCATION)
        .send()
        .await
    }

    /// Lists all playlists for the authenticated user
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use tidlers::{TidalClient, auth::init::TidalAuth};
    /// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
    /// # let auth = TidalAuth::with_oauth();
    /// # let client = TidalClient::new(&auth);
    /// let playlists = client.list_playlists().await?;
    /// for playlist in playlists.items {
    ///     println!("{}: {} tracks", playlist.title, playlist.number_of_tracks);
    /// }
    /// # Ok(())
    /// # }
    /// ```
    pub async fn list_playlists(&self) -> Result<PlaylistsResponse, TidalError> {
        let url = format!("/users/{}/playlists", self.user_id()?);

        self.request(reqwest::Method::GET, url)
            .with_country_code()
            .send()
            .await
    }

    /// Lists public playlists for a specific user
    pub async fn list_public_playlists(
        &self,
        limit: Option<u64>,
        offset: Option<u64>,
    ) -> Result<PublicUserPlaylistsResponse, TidalError> {
        let url = format!("/user-playlists/{}/public", self.user_id()?);

        self.request(reqwest::Method::GET, url)
            .with_country_code()
            .with_param("limit", limit.unwrap_or(50).to_string())
            .with_param("offset", offset.unwrap_or(0).to_string())
            .with_base_url(Self::API_V2_LOCATION)
            .send()
            .await
    }

    pub async fn get_playlist(
        &self,
        playlist_id: impl Into<PlaylistId>,
    ) -> Result<PlaylistInfo, TidalError> {
        let playlist_id = playlist_id.into();
        self.request(reqwest::Method::GET, format!("/playlists/{}/", playlist_id))
            .with_country_code()
            .send()
            .await
    }

    pub async fn get_playlist_items(
        &self,
        playlist_id: impl Into<PlaylistId>,
        limit: Option<u64>,
        offset: Option<u64>,
    ) -> Result<PlaylistItemsResponse, TidalError> {
        let playlist_id = playlist_id.into();
        let limit = limit.unwrap_or(20);
        let offset = offset.unwrap_or(0);

        if limit > 100 {
            return Err(TidalError::InvalidArgument(
                "limit cannot be greater than 100".to_string(),
            ));
        }

        self.request(
            reqwest::Method::GET,
            format!("/playlists/{}/items", playlist_id),
        )
        .with_country_code()
        .with_param("limit", limit.to_string())
        .with_param("offset", offset.to_string())
        .send()
        .await
    }

    pub async fn get_playlist_recommendations_items(
        &self,
        playlist_id: impl Into<PlaylistId>,
        limit: Option<u64>,
        offset: Option<u64>,
    ) -> Result<PlaylistItemsResponse, TidalError> {
        let playlist_id = playlist_id.into();
        let limit = limit.unwrap_or(20);
        let offset = offset.unwrap_or(0);

        if limit > 100 {
            return Err(TidalError::InvalidArgument(
                "limit cannot be greater than 100".to_string(),
            ));
        }

        self.request(
            reqwest::Method::GET,
            format!("/playlists/{}/recommendations/items", playlist_id),
        )
        .with_country_code()
        .with_param("limit", limit.to_string())
        .with_param("offset", offset.to_string())
        .send()
        .await
    }
}