//! `POST /_matrix/client/*/rooms/{roomId}/leave`

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

    use ruma_common::api::ruma_api;
    use ruma_identifiers::RoomId;

    ruma_api! {
        metadata: {
            description: "Leave a room.",
            method: POST,
            name: "leave_room",
            r0_path: "/_matrix/client/r0/rooms/:room_id/leave",
            stable_path: "/_matrix/client/v3/rooms/:room_id/leave",
            rate_limited: true,
            authentication: AccessToken,
            added: 1.0,
        }

        request: {
            /// The room to leave.
            #[ruma_api(path)]
            pub room_id: &'a RoomId,

            /// Optional reason to be included as the `reason` on the subsequent membership event.
            #[serde(skip_serializing_if = "Option::is_none")]
            pub reason: Option<&'a str>,
        }

        #[derive(Default)]
        response: {}

        error: crate::Error
    }

    impl<'a> Request<'a> {
        /// Creates a new `Request` with the given room id.
        pub fn new(room_id: &'a RoomId) -> Self {
            Self { room_id, reason: None }
        }
    }

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