// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: fm.teal.alpha.stats.getTopReleases
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

#[allow(unused_imports)]
use alloc::collections::BTreeMap;

#[allow(unused_imports)]
use core::marker::PhantomData;
use jacquard_common::{CowStr, BosStr, DefaultStr, FromStaticStr};
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::value::Data;
use jacquard_derive::IntoStatic;
use serde::{Serialize, Deserialize};
use crate::fm_teal::alpha::stats::ReleaseView;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetTopReleases<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cursor: Option<S>,
    /// Defaults to `50`. Min: 1. Max: 100.
    #[serde(default = "_default_limit")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
    /// Defaults to `"all"`.
    #[serde(default = "_default_period")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub period: Option<S>,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetTopReleasesOutput<S: BosStr = DefaultStr> {
    ///Next page cursor
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cursor: Option<S>,
    pub releases: Vec<ReleaseView<S>>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/** Response marker for the `fm.teal.alpha.stats.getTopReleases` query.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `GetTopReleasesOutput<S>` for this endpoint.*/
pub struct GetTopReleasesResponse;
impl jacquard_common::xrpc::XrpcResp for GetTopReleasesResponse {
    const NSID: &'static str = "fm.teal.alpha.stats.getTopReleases";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = GetTopReleasesOutput<S>;
    type Err = jacquard_common::xrpc::GenericError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetTopReleases<S> {
    const NSID: &'static str = "fm.teal.alpha.stats.getTopReleases";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetTopReleasesResponse;
}

/** Endpoint marker for the `fm.teal.alpha.stats.getTopReleases` query.

Path: `/xrpc/fm.teal.alpha.stats.getTopReleases`. The request payload type is `GetTopReleases<S>`; send that request with `jacquard::Client` or use this marker through lower-level `XrpcEndpoint` APIs.*/
pub struct GetTopReleasesRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetTopReleasesRequest {
    const PATH: &'static str = "/xrpc/fm.teal.alpha.stats.getTopReleases";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<S: BosStr> = GetTopReleases<S>;
    type Response = GetTopReleasesResponse;
}

fn _default_limit() -> Option<i64> {
    Some(50i64)
}

fn _default_period<S: jacquard_common::FromStaticStr>() -> Option<S> {
    Some(S::from_static("all"))
}

pub mod get_top_releases_state {

    pub use crate::builder_types::{Set, Unset, IsSet, IsUnset};
    #[allow(unused)]
    use ::core::marker::PhantomData;
    mod sealed {
        pub trait Sealed {}
    }
    /// State trait tracking which required fields have been set
    pub trait State: sealed::Sealed {}
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {}
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {}
}

/// Builder for constructing an instance of this type.
pub struct GetTopReleasesBuilder<
    St: get_top_releases_state::State,
    S: BosStr = DefaultStr,
> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<S>, Option<i64>, Option<S>),
    _type: PhantomData<fn() -> S>,
}

impl GetTopReleases<DefaultStr> {
    /// Create a new builder for this type, using the default string type (DefaultStr = SmolStr) if needed
    pub fn new() -> GetTopReleasesBuilder<get_top_releases_state::Empty, DefaultStr> {
        GetTopReleasesBuilder::new()
    }
}

impl<S: BosStr> GetTopReleases<S> {
    /// Create a new builder for this type
    pub fn builder() -> GetTopReleasesBuilder<get_top_releases_state::Empty, S> {
        GetTopReleasesBuilder::builder()
    }
}

impl GetTopReleasesBuilder<get_top_releases_state::Empty, DefaultStr> {
    /// Create a new builder with all fields unset, using the default string type, if needed
    pub fn new() -> Self {
        GetTopReleasesBuilder {
            _state: PhantomData,
            _fields: (None, None, None),
            _type: PhantomData,
        }
    }
}

impl<S: BosStr> GetTopReleasesBuilder<get_top_releases_state::Empty, S> {
    /// Create a new builder with all fields unset
    pub fn builder() -> Self {
        GetTopReleasesBuilder {
            _state: PhantomData,
            _fields: (None, None, None),
            _type: PhantomData,
        }
    }
}

impl<St: get_top_releases_state::State, S: BosStr> GetTopReleasesBuilder<St, S> {
    /// Set the `cursor` field (optional)
    pub fn cursor(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `cursor` field to an Option value (optional)
    pub fn maybe_cursor(mut self, value: Option<S>) -> Self {
        self._fields.0 = value;
        self
    }
}

impl<St: get_top_releases_state::State, S: BosStr> GetTopReleasesBuilder<St, S> {
    /// Set the `limit` field (optional)
    pub fn limit(mut self, value: impl Into<Option<i64>>) -> Self {
        self._fields.1 = value.into();
        self
    }
    /// Set the `limit` field to an Option value (optional)
    pub fn maybe_limit(mut self, value: Option<i64>) -> Self {
        self._fields.1 = value;
        self
    }
}

impl<St: get_top_releases_state::State, S: BosStr> GetTopReleasesBuilder<St, S> {
    /// Set the `period` field (optional)
    pub fn period(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.2 = value.into();
        self
    }
    /// Set the `period` field to an Option value (optional)
    pub fn maybe_period(mut self, value: Option<S>) -> Self {
        self._fields.2 = value;
        self
    }
}

impl<St, S: BosStr> GetTopReleasesBuilder<St, S>
where
    St: get_top_releases_state::State,
{
    /// Build the final struct.
    pub fn build(self) -> GetTopReleases<S> {
        GetTopReleases {
            cursor: self._fields.0,
            limit: self._fields.1,
            period: self._fields.2,
        }
    }
}