jacquard-api 0.12.0-beta.1

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.live.getRecommendations
//
// 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};

#[allow(unused_imports)]
use jacquard_common::deps::codegen::unicode_segmentation::UnicodeSegmentation;
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::string::Did;
use jacquard_common::types::value::Data;
use jacquard_derive::IntoStatic;
use jacquard_lexicon::lexicon::LexiconDoc;
use jacquard_lexicon::schema::LexiconSchema;

#[allow(unused_imports)]
use jacquard_lexicon::validation::{ConstraintError, ValidationPath};
use serde::{Serialize, Deserialize};
use crate::place_stream::live::get_recommendations;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct LivestreamRecommendation<S: BosStr = DefaultStr> {
    ///The DID of the recommended streamer
    pub did: Did<S>,
    ///Source of the recommendation
    pub source: S,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}


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


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetRecommendationsOutput<S: BosStr = DefaultStr> {
    ///Ordered list of recommendations
    pub recommendations: Vec<get_recommendations::LivestreamRecommendation<S>>,
    ///The user DID this recommendation is for
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user_did: Option<Did<S>>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

impl<S: BosStr> LexiconSchema for LivestreamRecommendation<S> {
    fn nsid() -> &'static str {
        "place.stream.live.getRecommendations"
    }
    fn def_name() -> &'static str {
        "livestreamRecommendation"
    }
    fn lexicon_doc() -> LexiconDoc<'static> {
        lexicon_doc_place_stream_live_getRecommendations()
    }
    fn validate(&self) -> Result<(), ConstraintError> {
        Ok(())
    }
}

/// Response type for place.stream.live.getRecommendations
pub struct GetRecommendationsResponse;
impl jacquard_common::xrpc::XrpcResp for GetRecommendationsResponse {
    const NSID: &'static str = "place.stream.live.getRecommendations";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = GetRecommendationsOutput<S>;
    type Err = jacquard_common::xrpc::GenericError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetRecommendations<S> {
    const NSID: &'static str = "place.stream.live.getRecommendations";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetRecommendationsResponse;
}

/// Endpoint type for place.stream.live.getRecommendations
pub struct GetRecommendationsRequest;
impl jacquard_common::xrpc::XrpcEndpoint for GetRecommendationsRequest {
    const PATH: &'static str = "/xrpc/place.stream.live.getRecommendations";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Request<S: BosStr> = GetRecommendations<S>;
    type Response = GetRecommendationsResponse;
}

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

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

impl<S: BosStr> LivestreamRecommendation<S> {
    /// Create a new builder for this type.
    pub fn new() -> LivestreamRecommendationBuilder<
        S,
        livestream_recommendation_state::Empty,
    > {
        LivestreamRecommendationBuilder::new()
    }
}

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

impl<S: BosStr, St> LivestreamRecommendationBuilder<S, St>
where
    St: livestream_recommendation_state::State,
    St::Did: livestream_recommendation_state::IsUnset,
{
    /// Set the `did` field (required)
    pub fn did(
        mut self,
        value: impl Into<Did<S>>,
    ) -> LivestreamRecommendationBuilder<
        S,
        livestream_recommendation_state::SetDid<St>,
    > {
        self._fields.0 = Option::Some(value.into());
        LivestreamRecommendationBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> LivestreamRecommendationBuilder<S, St>
where
    St: livestream_recommendation_state::State,
    St::Source: livestream_recommendation_state::IsUnset,
{
    /// Set the `source` field (required)
    pub fn source(
        mut self,
        value: impl Into<S>,
    ) -> LivestreamRecommendationBuilder<
        S,
        livestream_recommendation_state::SetSource<St>,
    > {
        self._fields.1 = Option::Some(value.into());
        LivestreamRecommendationBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> LivestreamRecommendationBuilder<S, St>
where
    St: livestream_recommendation_state::State,
    St::Source: livestream_recommendation_state::IsSet,
    St::Did: livestream_recommendation_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> LivestreamRecommendation<S> {
        LivestreamRecommendation {
            did: self._fields.0.unwrap(),
            source: self._fields.1.unwrap(),
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(
        self,
        extra_data: BTreeMap<SmolStr, Data<S>>,
    ) -> LivestreamRecommendation<S> {
        LivestreamRecommendation {
            did: self._fields.0.unwrap(),
            source: self._fields.1.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}

fn lexicon_doc_place_stream_live_getRecommendations() -> LexiconDoc<'static> {
    #[allow(unused_imports)]
    use jacquard_common::{CowStr, deps::smol_str::SmolStr, types::blob::MimeType};
    use jacquard_lexicon::lexicon::*;
    use alloc::collections::BTreeMap;
    LexiconDoc {
        lexicon: Lexicon::Lexicon1,
        id: CowStr::new_static("place.stream.live.getRecommendations"),
        defs: {
            let mut map = BTreeMap::new();
            map.insert(
                SmolStr::new_static("livestreamRecommendation"),
                LexUserType::Object(LexObject {
                    required: Some(
                        vec![SmolStr::new_static("did"), SmolStr::new_static("source")],
                    ),
                    properties: {
                        #[allow(unused_mut)]
                        let mut map = BTreeMap::new();
                        map.insert(
                            SmolStr::new_static("did"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static("The DID of the recommended streamer"),
                                ),
                                format: Some(LexStringFormat::Did),
                                ..Default::default()
                            }),
                        );
                        map.insert(
                            SmolStr::new_static("source"),
                            LexObjectProperty::String(LexString {
                                description: Some(
                                    CowStr::new_static("Source of the recommendation"),
                                ),
                                ..Default::default()
                            }),
                        );
                        map
                    },
                    ..Default::default()
                }),
            );
            map.insert(
                SmolStr::new_static("main"),
                LexUserType::XrpcQuery(LexXrpcQuery {
                    parameters: Some(
                        LexXrpcQueryParameter::Params(LexXrpcParameters {
                            required: Some(vec![SmolStr::new_static("userDID")]),
                            properties: {
                                #[allow(unused_mut)]
                                let mut map = BTreeMap::new();
                                map.insert(
                                    SmolStr::new_static("userDID"),
                                    LexXrpcParametersProperty::String(LexString {
                                        description: Some(
                                            CowStr::new_static(
                                                "The DID of the user whose recommendations to fetch",
                                            ),
                                        ),
                                        format: Some(LexStringFormat::Did),
                                        ..Default::default()
                                    }),
                                );
                                map
                            },
                            ..Default::default()
                        }),
                    ),
                    ..Default::default()
                }),
            );
            map
        },
        ..Default::default()
    }
}

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

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

impl<S: BosStr> GetRecommendations<S> {
    /// Create a new builder for this type.
    pub fn new() -> GetRecommendationsBuilder<S, get_recommendations_state::Empty> {
        GetRecommendationsBuilder::new()
    }
}

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

impl<S: BosStr, St> GetRecommendationsBuilder<S, St>
where
    St: get_recommendations_state::State,
    St::UserDid: get_recommendations_state::IsUnset,
{
    /// Set the `userDID` field (required)
    pub fn user_did(
        mut self,
        value: impl Into<Did<S>>,
    ) -> GetRecommendationsBuilder<S, get_recommendations_state::SetUserDid<St>> {
        self._fields.0 = Option::Some(value.into());
        GetRecommendationsBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<S: BosStr, St> GetRecommendationsBuilder<S, St>
where
    St: get_recommendations_state::State,
    St::UserDid: get_recommendations_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GetRecommendations<S> {
        GetRecommendations {
            user_did: self._fields.0.unwrap(),
        }
    }
}