am-api 1.1.0

A library for interfacing with the Apple Music 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
168
169
170
171
172
173
174
175

//! History implementation

use crate::error::Error;
use crate::primitive::TrackType;
use crate::request::builder::MusicRequestBuilder;
use crate::request::paginated::paginate;
use crate::resource::Resource;
use crate::ApiClient;
use futures::Stream;

/// History
pub struct History;

impl History {
    /// Get history information
    pub fn get<'a>() -> HistoryGetRequestBuilder<'a> {
        HistoryGetRequestBuilder::default()
    }
}

/// History request builder
pub struct HistoryRequestBuilder;

/// History get request builder
pub type HistoryGetRequestBuilder<'a> = MusicRequestBuilder<'a, HistoryRequestBuilder>;

impl<'a> HistoryGetRequestBuilder<'a> {
    /// Fetch heavy rotation content
    ///
    /// # Params
    ///
    /// * limit - limit of entries per query
    ///
    /// * offset - query offset
    ///
    /// Possible resources: any
    pub async fn heavy_rotation(
        mut self,
        client: &ApiClient,
        limit: usize,
        offset: usize,
    ) -> impl Stream<Item = Result<Resource, Error>> {
        let mut request_context = self.get_request_context_drain(client);
        request_context
            .query
            .push((String::from("limit"), limit.to_string()));

        paginate(
            client.clone(),
            String::from("/v1/me/history/heavy-rotation"),
            request_context,
            offset,
        )
    }

    /// Fetch recently played resources
    ///
    /// # Params
    ///
    /// * limit - limit of entries per query
    ///
    /// * offset - query offset
    ///
    /// Possible resources: any
    pub async fn recently_played(
        mut self,
        client: &ApiClient,
        limit: usize,
        offset: usize,
    ) -> impl Stream<Item = Result<Resource, Error>> {
        let mut request_context = self.get_request_context_drain(client);
        request_context
            .query
            .push((String::from("limit"), limit.to_string()));

        paginate(
            client.clone(),
            String::from("/v1/me/recent/played"),
            request_context,
            offset,
        )
    }

    /// Fetch recently played tracks
    ///
    /// # Params
    ///
    /// * limit - limit of entries per query
    ///
    /// * offset - query offset
    ///
    /// Possible resources: [`LibraryMusicVideo`], [`LibrarySong`], [`MusicVideo`], [`Song`]
    pub async fn recently_played_tracks(
        mut self,
        client: &ApiClient,
        tracks: &[TrackType],
        limit: usize,
        offset: usize,
    ) -> impl Stream<Item = Result<Resource, Error>> {
        let mut request_context = self.get_request_context_drain(client);
        request_context
            .query
            .push((String::from("limit"), limit.to_string()));
        request_context.query.push((
            String::from("types"),
            tracks
                .iter()
                .map(|e| e.to_string())
                .collect::<Vec<_>>()
                .join(","),
        ));

        paginate(
            client.clone(),
            String::from("/v1/me/recent/played/tracks"),
            request_context,
            offset,
        )
    }

    /// Fetch recently played radio stations
    ///
    /// # Params
    ///
    /// * limit - limit of entries per query
    ///
    /// * offset - query offset
    ///
    /// Possible resources: [`Station`]
    pub async fn recently_played_stations(
        mut self,
        client: &ApiClient,
        limit: usize,
        offset: usize,
    ) -> impl Stream<Item = Result<Resource, Error>> {
        let mut request_context = self.get_request_context_drain(client);
        request_context
            .query
            .push((String::from("limit"), limit.to_string()));

        paginate(
            client.clone(),
            String::from("/v1/me/recent/radio-stations"),
            request_context,
            offset,
        )
    }

    /// Fetch resources recently added to the library
    /// # Params
    ///
    /// * limit - limit of entries per query
    ///
    /// * offset - query offset
    ///
    /// Possible resources: [`LibraryAlbum`], [`LibraryArtist`], [`LibraryPlaylist`], [`LibrarySong`]
    pub async fn recently_added_to_library(
        mut self,
        client: &ApiClient,
        limit: usize,
        offset: usize,
    ) -> impl Stream<Item = Result<Resource, Error>> {
        let mut request_context = self.get_request_context_drain(client);
        request_context
            .query
            .push((String::from("limit"), limit.to_string()));

        paginate(
            client.clone(),
            String::from("/v1/me/library/recently-added"),
            request_context,
            offset,
        )
    }
}