// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: app.rocksky.song.getSongs
//
// 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::app_rocksky::song::SongViewBasic;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct GetSongs {
    /// (min: 1)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
    /// (min: 0)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub offset: Option<i64>,
}


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

/** Response marker for the `app.rocksky.song.getSongs` query.

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

impl jacquard_common::xrpc::XrpcRequest for GetSongs {
    const NSID: &'static str = "app.rocksky.song.getSongs";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetSongsResponse;
}

/** Endpoint marker for the `app.rocksky.song.getSongs` query.

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

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

impl GetSongs {
    /// Create a new builder for this type.
    pub fn new() -> GetSongsBuilder<get_songs_state::Empty> {
        GetSongsBuilder::new()
    }
}

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

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

impl<St: get_songs_state::State> GetSongsBuilder<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: get_songs_state::State> GetSongsBuilder<St> {
    /// Set the `offset` field (optional)
    pub fn offset(mut self, value: impl Into<Option<i64>>) -> Self {
        self._fields.1 = value.into();
        self
    }
    /// Set the `offset` field to an Option value (optional)
    pub fn maybe_offset(mut self, value: Option<i64>) -> Self {
        self._fields.1 = value;
        self
    }
}

impl<St> GetSongsBuilder<St>
where
    St: get_songs_state::State,
{
    /// Build the final struct.
    pub fn build(self) -> GetSongs {
        GetSongs {
            limit: self._fields.0,
            offset: self._fields.1,
        }
    }
}