//! `GET /_matrix/client/*/pushers`

pub mod v3 {
    //! `/v3/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.2/client-server-api/#get_matrixclientv3pushers

    use ruma_common::api::ruma_api;
    use serde::{Deserialize, Serialize};

    use crate::push::{PusherData, PusherKind};

    ruma_api! {
        metadata: {
            description: "Gets all currently active pushers for the authenticated user.",
            method: GET,
            name: "get_pushers",
            r0_path: "/_matrix/client/r0/pushers",
            stable_path: "/_matrix/client/v3/pushers",
            rate_limited: false,
            authentication: AccessToken,
            added: 1.0,
        }

        #[derive(Default)]
        request: {}

        response: {
            /// An array containing the current pushers for the user.
            pub pushers: Vec<Pusher>,
        }

        error: crate::Error
    }

    impl Request {
        /// Creates an empty `Request`.
        pub fn new() -> Self {
            Self {}
        }
    }

    impl Response {
        /// Creates a new `Response` with the given pushers.
        pub fn new(pushers: Vec<Pusher>) -> Self {
            Self { pushers }
        }
    }

    /// Defines a pusher.
    ///
    /// To create an instance of this type, first create a `PusherInit` and convert it via
    /// `Pusher::from` / `.into()`.
    #[derive(Clone, Debug, Serialize, Deserialize)]
    #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
    pub struct Pusher {
        /// A unique identifier for this pusher.
        ///
        /// The maximum allowed length is 512 bytes.
        pub pushkey: String,

        /// The kind of the pusher.
        pub kind: PusherKind,

        /// A reverse-DNS style identifier for the application.
        ///
        /// The maximum allowed length is 64 bytes.
        pub app_id: String,

        /// A string that will allow the user to identify what application owns this pusher.
        pub app_display_name: String,

        /// A string that will allow the user to identify what device owns this pusher.
        pub device_display_name: String,

        /// Determines which set of device specific rules this pusher executes.
        #[serde(skip_serializing_if = "Option::is_none")]
        pub profile_tag: Option<String>,

        /// The preferred language for receiving notifications (e.g. 'en' or 'en-US')
        pub lang: String,

        /// Information for the pusher implementation itself.
        pub data: PusherData,
    }

    /// Initial set of fields of `Pusher`.
    ///
    /// This struct will not be updated even if additional fields are added to `Pusher` in a new
    /// (non-breaking) release of the Matrix specification.
    #[derive(Debug)]
    #[allow(clippy::exhaustive_structs)]
    pub struct PusherInit {
        /// A unique identifier for this pusher.
        ///
        /// The maximum allowed length is 512 bytes.
        pub pushkey: String,

        /// The kind of the pusher.
        pub kind: PusherKind,

        /// A reverse-DNS style identifier for the application.
        ///
        /// The maximum allowed length is 64 bytes.
        pub app_id: String,

        /// A string that will allow the user to identify what application owns this pusher.
        pub app_display_name: String,

        /// A string that will allow the user to identify what device owns this pusher.
        pub device_display_name: String,

        /// Determines which set of device-specific rules this pusher executes.
        pub profile_tag: Option<String>,

        /// The preferred language for receiving notifications (e.g. 'en' or 'en-US').
        pub lang: String,

        /// Information for the pusher implementation itself.
        pub data: PusherData,
    }

    impl From<PusherInit> for Pusher {
        fn from(init: PusherInit) -> Self {
            let PusherInit {
                pushkey,
                kind,
                app_id,
                app_display_name,
                device_display_name,
                profile_tag,
                lang,
                data,
            } = init;
            Self {
                pushkey,
                kind,
                app_id,
                app_display_name,
                device_display_name,
                profile_tag,
                lang,
                data,
            }
        }
    }
}