jacquard-api 0.12.0

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.moderation.createPin
//
// 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::string::{Did, AtUri, Cid, Datetime};
use jacquard_common::types::value::Data;
use jacquard_derive::{IntoStatic, open_union};
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct CreatePin<S: BosStr = DefaultStr> {
    ///Optional expiration time for this pin.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub expires_at: Option<Datetime>,
    ///The AT-URI of the chat message to pin.
    pub message_uri: AtUri<S>,
    ///The DID of the streamer.
    pub streamer: Did<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 CreatePinOutput<S: BosStr = DefaultStr> {
    ///The CID of the created pinned record.
    pub cid: Cid<S>,
    ///The AT-URI of the created pinned record.
    pub uri: AtUri<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,
    thiserror::Error,
    miette::Diagnostic
)]

#[serde(tag = "error", content = "message")]
pub enum CreatePinError {
    /// The request lacks valid authentication credentials.
    #[serde(rename = "Unauthorized")]
    Unauthorized(Option<SmolStr>),
    /// The caller does not have permission to pin messages for this streamer.
    #[serde(rename = "Forbidden")]
    Forbidden(Option<SmolStr>),
    /// The streamer's OAuth session could not be found or is invalid.
    #[serde(rename = "SessionNotFound")]
    SessionNotFound(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

impl core::fmt::Display for CreatePinError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::Unauthorized(msg) => {
                write!(f, "Unauthorized")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::Forbidden(msg) => {
                write!(f, "Forbidden")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::SessionNotFound(msg) => {
                write!(f, "SessionNotFound")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::Other { error, message } => {
                write!(f, "{}", error)?;
                if let Some(msg) = message {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
        }
    }
}

/** Response marker for the `place.stream.moderation.createPin` procedure.

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

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for CreatePin<S> {
    const NSID: &'static str = "place.stream.moderation.createPin";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = CreatePinResponse;
}

/** Endpoint marker for the `place.stream.moderation.createPin` procedure.

Path: `/xrpc/place.stream.moderation.createPin`. The request payload type is `CreatePin<S>`; send that request with `jacquard::Client` or use this marker through lower-level `XrpcEndpoint` APIs.*/
pub struct CreatePinRequest;
impl jacquard_common::xrpc::XrpcEndpoint for CreatePinRequest {
    const PATH: &'static str = "/xrpc/place.stream.moderation.createPin";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<S: BosStr> = CreatePin<S>;
    type Response = CreatePinResponse;
}

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

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

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

impl<S: BosStr> CreatePin<S> {
    /// Create a new builder for this type
    pub fn builder() -> CreatePinBuilder<create_pin_state::Empty, S> {
        CreatePinBuilder::builder()
    }
}

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

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

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

impl<St, S: BosStr> CreatePinBuilder<St, S>
where
    St: create_pin_state::State,
    St::MessageUri: create_pin_state::IsUnset,
{
    /// Set the `messageUri` field (required)
    pub fn message_uri(
        mut self,
        value: impl Into<AtUri<S>>,
    ) -> CreatePinBuilder<create_pin_state::SetMessageUri<St>, S> {
        self._fields.1 = Option::Some(value.into());
        CreatePinBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> CreatePinBuilder<St, S>
where
    St: create_pin_state::State,
    St::Streamer: create_pin_state::IsUnset,
{
    /// Set the `streamer` field (required)
    pub fn streamer(
        mut self,
        value: impl Into<Did<S>>,
    ) -> CreatePinBuilder<create_pin_state::SetStreamer<St>, S> {
        self._fields.2 = Option::Some(value.into());
        CreatePinBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> CreatePinBuilder<St, S>
where
    St: create_pin_state::State,
    St::MessageUri: create_pin_state::IsSet,
    St::Streamer: create_pin_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> CreatePin<S> {
        CreatePin {
            expires_at: self._fields.0,
            message_uri: self._fields.1.unwrap(),
            streamer: self._fields.2.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>>,
    ) -> CreatePin<S> {
        CreatePin {
            expires_at: self._fields.0,
            message_uri: self._fields.1.unwrap(),
            streamer: self._fields.2.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}