mangadex_api/v5/custom_list/id/
delete.rs

1//! Builder for the CustomList delete endpoint.
2//!
3//! <https://api.mangadex.org/docs/swagger.html#/CustomList/delete-list-id>
4//!
5//! # Examples
6//!
7//! ```rust
8//! use uuid::Uuid;
9//!
10//! use mangadex_api::v5::MangaDexClient;
11//! use mangadex_api_types::{Password, Username};
12//!
13//! # async fn run() -> anyhow::Result<()> {
14//! let client = MangaDexClient::default();
15//!
16//! /*
17//!     // Put your login code here
18//!     let _login_res = client
19//!         .auth()
20//!         .login()
21//!         .post()
22//!         .username(Username::parse("myusername")?)
23//!         .password(Password::parse("hunter23")?)
24//!         .send()
25//!         .await?;
26//! */
27//! let list_id = Uuid::new_v4();
28//! let res = client
29//!     .custom_list()
30//!     .id(list_id)
31//!     .delete()
32//!     .send()
33//!     .await?;
34//!
35//! println!("delete: {:?}", res);
36//! # Ok(())
37//! # }
38//! ```
39
40use derive_builder::Builder;
41use serde::Serialize;
42use uuid::Uuid;
43
44use crate::HttpClientRef;
45use crate::Result;
46use mangadex_api_schema::NoData;
47
48#[cfg_attr(
49    feature = "deserializable-endpoint",
50    derive(serde::Deserialize, getset::Getters, getset::Setters)
51)]
52#[derive(Debug, Serialize, Clone, Builder)]
53#[serde(rename_all = "camelCase")]
54#[builder(
55    setter(into, strip_option),
56    build_fn(error = "crate::error::BuilderError")
57)]
58#[non_exhaustive]
59pub struct DeleteCustomList {
60    /// This should never be set manually as this is only for internal use.
61    #[doc(hidden)]
62    #[serde(skip)]
63    #[builder(pattern = "immutable")]
64    #[cfg_attr(feature = "deserializable-endpoint", getset(set = "pub", get = "pub"))]
65    pub http_client: HttpClientRef,
66
67    #[serde(skip_serializing)]
68    pub list_id: Uuid,
69}
70
71endpoint! {
72    DELETE ("/list/{}", list_id),
73    #[no_data auth] DeleteCustomList,
74    #[discard_result] Result<NoData>,
75    DeleteCustomListBuilder
76}
77
78#[cfg(test)]
79mod tests {
80    use serde_json::json;
81    use url::Url;
82    use uuid::Uuid;
83    use wiremock::matchers::{header, method, path_regex};
84    use wiremock::{Mock, MockServer, ResponseTemplate};
85
86    use crate::v5::AuthTokens;
87    use crate::{HttpClient, MangaDexClient};
88
89    #[tokio::test]
90    async fn delete_custom_list_fires_a_request_to_base_url() -> anyhow::Result<()> {
91        let mock_server = MockServer::start().await;
92        let http_client = HttpClient::builder()
93            .base_url(Url::parse(&mock_server.uri())?)
94            .auth_tokens(non_exhaustive::non_exhaustive!(AuthTokens {
95                session: "sessiontoken".to_string(),
96                refresh: "refreshtoken".to_string(),
97            }))
98            .build()?;
99        let mangadex_client = MangaDexClient::new_with_http_client(http_client);
100
101        let list_id = Uuid::new_v4();
102        let response_body = json!({
103            "result": "ok",
104        });
105
106        Mock::given(method("DELETE"))
107            .and(path_regex(r"/list/[0-9a-fA-F-]+"))
108            .and(header("Authorization", "Bearer sessiontoken"))
109            .respond_with(ResponseTemplate::new(200).set_body_json(response_body))
110            .expect(1)
111            .mount(&mock_server)
112            .await;
113
114        mangadex_client
115            .custom_list()
116            .id(list_id)
117            .delete()
118            .send()
119            .await?;
120
121        Ok(())
122    }
123}
mangadex_api/v5/custom_list/id/delete.rs

mangadex_api/v5/custom_list/id/
delete.rs
