// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: sh.weaver.notebook.getPublishedVersions
//
// 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::string::AtUri;
use jacquard_common::types::value::Data;
use jacquard_derive::IntoStatic;
use serde::{Serialize, Deserialize};
use crate::sh_weaver::notebook::PublishedVersionView;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetPublishedVersions<S: BosStr = DefaultStr> {
    pub entry: AtUri<S>,
    ///  Defaults to `false`.
    #[serde(default = "_default_include_content")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub include_content: Option<bool>,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetPublishedVersionsOutput<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub canonical: Option<PublishedVersionView<S>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub has_divergence: Option<bool>,
    ///Full entry records if includeContent=true
    #[serde(skip_serializing_if = "Option::is_none")]
    pub records: Option<Vec<Data<S>>>,
    pub versions: Vec<PublishedVersionView<S>>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/** Response marker for the `sh.weaver.notebook.getPublishedVersions` query.

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

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetPublishedVersions<S> {
    const NSID: &'static str = "sh.weaver.notebook.getPublishedVersions";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetPublishedVersionsResponse;
}

/** Endpoint marker for the `sh.weaver.notebook.getPublishedVersions` query.

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

fn _default_include_content() -> Option<bool> {
    Some(false)
}

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

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

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

impl<S: BosStr> GetPublishedVersions<S> {
    /// Create a new builder for this type
    pub fn builder() -> GetPublishedVersionsBuilder<
        get_published_versions_state::Empty,
        S,
    > {
        GetPublishedVersionsBuilder::builder()
    }
}

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

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

impl<St, S: BosStr> GetPublishedVersionsBuilder<St, S>
where
    St: get_published_versions_state::State,
    St::Entry: get_published_versions_state::IsUnset,
{
    /// Set the `entry` field (required)
    pub fn entry(
        mut self,
        value: impl Into<AtUri<S>>,
    ) -> GetPublishedVersionsBuilder<get_published_versions_state::SetEntry<St>, S> {
        self._fields.0 = Option::Some(value.into());
        GetPublishedVersionsBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<
    St: get_published_versions_state::State,
    S: BosStr,
> GetPublishedVersionsBuilder<St, S> {
    /// Set the `includeContent` field (optional)
    pub fn include_content(mut self, value: impl Into<Option<bool>>) -> Self {
        self._fields.1 = value.into();
        self
    }
    /// Set the `includeContent` field to an Option value (optional)
    pub fn maybe_include_content(mut self, value: Option<bool>) -> Self {
        self._fields.1 = value;
        self
    }
}

impl<St, S: BosStr> GetPublishedVersionsBuilder<St, S>
where
    St: get_published_versions_state::State,
    St::Entry: get_published_versions_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GetPublishedVersions<S> {
        GetPublishedVersions {
            entry: self._fields.0.unwrap(),
            include_content: self._fields.1,
        }
    }
}