logo
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

//! `GET /_matrix/identity/*/terms`
//!
//! Endpoint to retrieve the terms of service of an identity server.

pub mod v2 {
    //! `/v2/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.2/identity-service-api/#get_matrixidentityv2terms

    use std::collections::BTreeMap;

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

    ruma_api! {
        metadata: {
            description: "Gets all the terms of service offered by the server.",
            method: GET,
            name: "get_terms_of_service",
            stable_path: "/_matrix/identity/v2/terms",
            authentication: None,
            rate_limited: false,
            added: 1.0,
        }

        #[derive(Default)]
        request: {}

        response: {
            /// The policies the server offers.
            ///
            /// Mapped from arbitrary ID (unused in this version of the specification) to a Policy Object.
            pub policies: BTreeMap<String, Policies>,
        }
    }

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

    impl Response {
        /// Creates a new `Response` with the given `Policies`.
        pub fn new(policies: BTreeMap<String, Policies>) -> Self {
            Self { policies }
        }
    }

    /// Collection of localized policies.
    #[derive(Clone, Debug, Serialize, Deserialize)]
    #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
    pub struct Policies {
        /// The version for the policy.
        ///
        /// There are no requirements on what this might be and could be
        /// "alpha", semantically versioned, or arbitrary.
        pub version: String,

        /// Available languages for the policy.
        ///
        /// The keys could be the language code corresponding to
        /// the given `LocalizedPolicy`, for example "en" or "fr".
        #[serde(flatten)]
        pub localized: BTreeMap<String, LocalizedPolicy>,
    }

    impl Policies {
        /// Create a new `Policies` with the given version and localized map.
        pub fn new(version: String, localized: BTreeMap<String, LocalizedPolicy>) -> Self {
            Self { version, localized }
        }
    }

    /// A localized policy offered by a server.
    #[derive(Clone, Debug, Serialize, Deserialize)]
    #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
    pub struct LocalizedPolicy {
        /// The localized name of the policy.
        ///
        /// Examples are "Terms of Service", "Conditions d'utilisation".
        pub name: String,

        /// The URL at which the policy is available.
        ///
        /// Examples are `https://example.org/somewhere/terms-2.0-en.html`
        /// and `https://example.org/somewhere/terms-2.0-fr.html`.
        pub url: String,
    }

    impl LocalizedPolicy {
        /// Create a new `LocalizedPolicy` with the given name and url.
        pub fn new(name: String, url: String) -> Self {
            Self { name, url }
        }
    }
}