// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: org.passingreads.book.getLocationBooks
//
// 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::org_passingreads::book::StatefulBook;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetLocationBooks<S: BosStr = DefaultStr> {
    pub h3: S,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetLocationBooksOutput<S: BosStr = DefaultStr> {
    pub books: Vec<StatefulBook<S>>,
    ///Human-readable name of the requested location
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_name: Option<S>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/** Response marker for the `org.passingreads.book.getLocationBooks` query.

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

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetLocationBooks<S> {
    const NSID: &'static str = "org.passingreads.book.getLocationBooks";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetLocationBooksResponse;
}

/** Endpoint marker for the `org.passingreads.book.getLocationBooks` query.

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

pub mod get_location_books_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 {
        type H3;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type H3 = Unset;
    }
    ///State transition - sets the `h3` field to Set
    pub struct SetH3<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetH3<St> {}
    impl<St: State> State for SetH3<St> {
        type H3 = Set<members::h3>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `h3` field
        pub struct h3(());
    }
}

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

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

impl<S: BosStr> GetLocationBooks<S> {
    /// Create a new builder for this type
    pub fn builder() -> GetLocationBooksBuilder<get_location_books_state::Empty, S> {
        GetLocationBooksBuilder::builder()
    }
}

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

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

impl<St, S: BosStr> GetLocationBooksBuilder<St, S>
where
    St: get_location_books_state::State,
    St::H3: get_location_books_state::IsUnset,
{
    /// Set the `h3` field (required)
    pub fn h3(
        mut self,
        value: impl Into<S>,
    ) -> GetLocationBooksBuilder<get_location_books_state::SetH3<St>, S> {
        self._fields.0 = Option::Some(value.into());
        GetLocationBooksBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> GetLocationBooksBuilder<St, S>
where
    St: get_location_books_state::State,
    St::H3: get_location_books_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GetLocationBooks<S> {
        GetLocationBooks {
            h3: self._fields.0.unwrap(),
        }
    }
}