jacquard-api 0.12.0

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: games.gamesgamesgamesgames.getPopularGames
//
// 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::{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::games_gamesgamesgamesgames::GameSummaryView;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct GetPopularGames {
    /// Defaults to `20`. Min: 1. Max: 100.
    #[serde(default = "_default_limit")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
}


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

/** Response marker for the `games.gamesgamesgamesgames.getPopularGames` query.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `GetPopularGamesOutput<S>` for this endpoint.*/
pub struct GetPopularGamesResponse;
impl jacquard_common::xrpc::XrpcResp for GetPopularGamesResponse {
    const NSID: &'static str = "games.gamesgamesgamesgames.getPopularGames";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = GetPopularGamesOutput<S>;
    type Err = jacquard_common::xrpc::GenericError;
}

impl jacquard_common::xrpc::XrpcRequest for GetPopularGames {
    const NSID: &'static str = "games.gamesgamesgamesgames.getPopularGames";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetPopularGamesResponse;
}

/** Endpoint marker for the `games.gamesgamesgamesgames.getPopularGames` query.

Path: `/xrpc/games.gamesgamesgamesgames.getPopularGames`. The request payload type is `GetPopularGames`; send that request with `jacquard::Client` or use this marker through lower-level `XrpcEndpoint` APIs.*/
pub struct GetPopularGamesRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetPopularGamesRequest {
    const PATH: &'static str = "/xrpc/games.gamesgamesgamesgames.getPopularGames";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<S: BosStr> = GetPopularGames;
    type Response = GetPopularGamesResponse;
}

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

pub mod get_popular_games_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 GetPopularGamesBuilder<St: get_popular_games_state::State> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<i64>,),
}

impl GetPopularGames {
    /// Create a new builder for this type.
    pub fn new() -> GetPopularGamesBuilder<get_popular_games_state::Empty> {
        GetPopularGamesBuilder::new()
    }
}

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

impl GetPopularGamesBuilder<get_popular_games_state::Empty> {
    /// Create a new builder with all fields unset
    pub fn builder() -> Self {
        GetPopularGamesBuilder {
            _state: PhantomData,
            _fields: (None,),
        }
    }
}

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

impl<St> GetPopularGamesBuilder<St>
where
    St: get_popular_games_state::State,
{
    /// Build the final struct.
    pub fn build(self) -> GetPopularGames {
        GetPopularGames {
            limit: self._fields.0,
        }
    }
}