speedrun-api 1.3.0

A wrapper for the speedrun.com REST 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

//! # Notifications
//!
//! Endpoints available for notifications.

use serde::Serialize;

use super::{endpoint::Endpoint, error::BodyError, query_params::QueryParams, Direction};

/// Sorting options for notifications
#[derive(Debug, Clone, Serialize, Copy)]
pub enum NotificationsSorting {
    /// Sort by the date the notification was created (default)
    Created,
}

/// Retrieves the notifications for the currently authenticated user.
#[derive(Default, Debug, Builder, Clone, Serialize)]
#[builder(default, setter(into, strip_option))]
#[serde(rename_all = "kebab-case")]
pub struct Notifications {
    #[doc = r"Sorting options for results (default: Sorted by date)."]
    orderby: Option<NotificationsSorting>,
    #[doc = r"Sort direction. (default: descending)"]
    direction: Option<Direction>,
}

impl Notifications {
    /// Create a builder for this endpoint.
    pub fn builder() -> NotificationsBuilder {
        NotificationsBuilder::default()
    }
}

impl Default for NotificationsSorting {
    fn default() -> Self {
        Self::Created
    }
}

impl Endpoint for Notifications {
    fn endpoint(&self) -> std::borrow::Cow<'static, str> {
        "notifications".into()
    }

    fn query_parameters(&self) -> Result<QueryParams<'_>, BodyError> {
        QueryParams::with(self)
    }

    fn requires_authentication(&self) -> bool {
        true
    }
}