jacquard-api 0.12.0

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.badge.getIssuedBadges
//
// 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;
use jacquard_common::types::value::Data;
use jacquard_derive::IntoStatic;
use serde::{Serialize, Deserialize};
use crate::place_stream::badge::BadgeSlot;
use crate::place_stream::badge::BadgeView;

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


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct GetIssuedBadgesOutput<S: BosStr = DefaultStr> {
    ///Computed server badge (streamer, mod, or bot) for the given streamer context. Absent if the user has no server role.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub server: Option<BadgeView<S>>,
    ///Streamer-issued badges (e.g. VIP) available to the user.
    pub streamer: BadgeSlot<S>,
    ///Globally-issued cosmetic badges (e.g. event) available to the user.
    pub user: BadgeSlot<S>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/** Response marker for the `place.stream.badge.getIssuedBadges` query.

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

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for GetIssuedBadges<S> {
    const NSID: &'static str = "place.stream.badge.getIssuedBadges";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Query;
    type Response = GetIssuedBadgesResponse;
}

/** Endpoint marker for the `place.stream.badge.getIssuedBadges` query.

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

pub mod get_issued_badges_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 GetIssuedBadgesBuilder<
    St: get_issued_badges_state::State,
    S: BosStr = DefaultStr,
> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<Did<S>>,),
    _type: PhantomData<fn() -> S>,
}

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

impl<S: BosStr> GetIssuedBadges<S> {
    /// Create a new builder for this type
    pub fn builder() -> GetIssuedBadgesBuilder<get_issued_badges_state::Empty, S> {
        GetIssuedBadgesBuilder::builder()
    }
}

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

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

impl<St: get_issued_badges_state::State, S: BosStr> GetIssuedBadgesBuilder<St, S> {
    /// Set the `streamer` field (optional)
    pub fn streamer(mut self, value: impl Into<Option<Did<S>>>) -> Self {
        self._fields.0 = value.into();
        self
    }
    /// Set the `streamer` field to an Option value (optional)
    pub fn maybe_streamer(mut self, value: Option<Did<S>>) -> Self {
        self._fields.0 = value;
        self
    }
}

impl<St, S: BosStr> GetIssuedBadgesBuilder<St, S>
where
    St: get_issued_badges_state::State,
{
    /// Build the final struct.
    pub fn build(self) -> GetIssuedBadges<S> {
        GetIssuedBadges {
            streamer: self._fields.0,
        }
    }
}