// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: systems.timker.hawlt.putNote
//
// 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, Cid, RecordKey, Rkey};
use jacquard_common::types::value::Data;
use jacquard_derive::IntoStatic;
use serde::{Serialize, Deserialize};
use crate::systems_timker::hawlt::note::Note;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct PutNote<S: BosStr = DefaultStr> {
    ///The note record to write.
    pub record: Note<S>,
    ///The record key (TID) for this note.
    pub rkey: RecordKey<Rkey<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 PutNoteOutput<S: BosStr = DefaultStr> {
    pub cid: Cid<S>,
    pub uri: AtUri<S>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/** Response marker for the `systems.timker.hawlt.putNote` procedure.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `PutNoteOutput<S>` for this endpoint.*/
pub struct PutNoteResponse;
impl jacquard_common::xrpc::XrpcResp for PutNoteResponse {
    const NSID: &'static str = "systems.timker.hawlt.putNote";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = PutNoteOutput<S>;
    type Err = jacquard_common::xrpc::GenericError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for PutNote<S> {
    const NSID: &'static str = "systems.timker.hawlt.putNote";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = PutNoteResponse;
}

/** Endpoint marker for the `systems.timker.hawlt.putNote` procedure.

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

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

/// Builder for constructing an instance of this type.
pub struct PutNoteBuilder<St: put_note_state::State, S: BosStr = DefaultStr> {
    _state: PhantomData<fn() -> St>,
    _fields: (Option<Note<S>>, Option<RecordKey<Rkey<S>>>),
    _type: PhantomData<fn() -> S>,
}

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

impl<S: BosStr> PutNote<S> {
    /// Create a new builder for this type
    pub fn builder() -> PutNoteBuilder<put_note_state::Empty, S> {
        PutNoteBuilder::builder()
    }
}

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

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

impl<St, S: BosStr> PutNoteBuilder<St, S>
where
    St: put_note_state::State,
    St::Record: put_note_state::IsUnset,
{
    /// Set the `record` field (required)
    pub fn record(
        mut self,
        value: impl Into<Note<S>>,
    ) -> PutNoteBuilder<put_note_state::SetRecord<St>, S> {
        self._fields.0 = Option::Some(value.into());
        PutNoteBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> PutNoteBuilder<St, S>
where
    St: put_note_state::State,
    St::Rkey: put_note_state::IsUnset,
{
    /// Set the `rkey` field (required)
    pub fn rkey(
        mut self,
        value: impl Into<RecordKey<Rkey<S>>>,
    ) -> PutNoteBuilder<put_note_state::SetRkey<St>, S> {
        self._fields.1 = Option::Some(value.into());
        PutNoteBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> PutNoteBuilder<St, S>
where
    St: put_note_state::State,
    St::Record: put_note_state::IsSet,
    St::Rkey: put_note_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> PutNote<S> {
        PutNote {
            record: self._fields.0.unwrap(),
            rkey: 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>>) -> PutNote<S> {
        PutNote {
            record: self._fields.0.unwrap(),
            rkey: self._fields.1.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}