// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.live.getSegments
//
// 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::{Did, Datetime};
use jacquard_common::types::value::Data;
use jacquard_derive::IntoStatic;
use serde::{Serialize, Deserialize};
use crate::place_stream::segment::SegmentView;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetSegments<S: BosStr = DefaultStr> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub before: Option<Datetime>,
    /// Defaults to `50`. Min: 1. Max: 100.
    #[serde(default = "_default_limit")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
    pub user_did: Did<S>,
}


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

/** Response marker for the `place.stream.live.getSegments` query.

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

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

/** Endpoint marker for the `place.stream.live.getSegments` query.

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

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

pub mod get_segments_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 GetSegmentsBuilder<St: get_segments_state::State, S: BosStr = DefaultStr> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<Datetime>, Option<i64>, Option<Did<S>>),
    _type: PhantomData<fn() -> S>,
}

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

impl<S: BosStr> GetSegments<S> {
    /// Create a new builder for this type
    pub fn builder() -> GetSegmentsBuilder<get_segments_state::Empty, S> {
        GetSegmentsBuilder::builder()
    }
}

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

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

impl<St: get_segments_state::State, S: BosStr> GetSegmentsBuilder<St, S> {
    /// Set the `before` field (optional)
    pub fn before(mut self, value: impl Into<Option<Datetime>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `before` field to an Option value (optional)
    pub fn maybe_before(mut self, value: Option<Datetime>) -> Self {
        self._fields.0 = value;
        self
    }
}

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

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

impl<St, S: BosStr> GetSegmentsBuilder<St, S>
where
    St: get_segments_state::State,
    St::UserDid: get_segments_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> GetSegments<S> {
        GetSegments {
            before: self._fields.0,
            limit: self._fields.1,
            user_did: self._fields.2.unwrap(),
        }
    }
}