jacquard-api 0.12.0

Generated AT Protocol API bindings for Jacquard
Documentation
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: io.atcr.hold.updateCrewTier
//
// 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;
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 UpdateCrewTier<S: BosStr = DefaultStr> {
    ///Tier rank index (0-based, maps to hold tier list by position).
    pub tier_rank: i64,
    ///DID of the crew member whose tier is being updated.
    pub user_did: 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, Default)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct UpdateCrewTierOutput<S: BosStr = DefaultStr> {
    ///Resolved tier name on this hold.
    pub tier_name: 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 UpdateCrewTierError {
    /// Valid appview token required.
    #[serde(rename = "AuthRequired")]
    AuthRequired(Option<SmolStr>),
    /// User is not a crew member on this hold.
    #[serde(rename = "UserNotFound")]
    UserNotFound(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

impl core::fmt::Display for UpdateCrewTierError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::AuthRequired(msg) => {
                write!(f, "AuthRequired")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::UserNotFound(msg) => {
                write!(f, "UserNotFound")?;
                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 `io.atcr.hold.updateCrewTier` procedure.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `UpdateCrewTierOutput<S>` for this endpoint.*/
pub struct UpdateCrewTierResponse;
impl jacquard_common::xrpc::XrpcResp for UpdateCrewTierResponse {
    const NSID: &'static str = "io.atcr.hold.updateCrewTier";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = UpdateCrewTierOutput<S>;
    type Err = UpdateCrewTierError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for UpdateCrewTier<S> {
    const NSID: &'static str = "io.atcr.hold.updateCrewTier";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = UpdateCrewTierResponse;
}

/** Endpoint marker for the `io.atcr.hold.updateCrewTier` procedure.

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

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

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

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

impl<S: BosStr> UpdateCrewTier<S> {
    /// Create a new builder for this type
    pub fn builder() -> UpdateCrewTierBuilder<update_crew_tier_state::Empty, S> {
        UpdateCrewTierBuilder::builder()
    }
}

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

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

impl<St, S: BosStr> UpdateCrewTierBuilder<St, S>
where
    St: update_crew_tier_state::State,
    St::TierRank: update_crew_tier_state::IsUnset,
{
    /// Set the `tierRank` field (required)
    pub fn tier_rank(
        mut self,
        value: impl Into<i64>,
    ) -> UpdateCrewTierBuilder<update_crew_tier_state::SetTierRank<St>, S> {
        self._fields.0 = Option::Some(value.into());
        UpdateCrewTierBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

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

impl<St, S: BosStr> UpdateCrewTierBuilder<St, S>
where
    St: update_crew_tier_state::State,
    St::TierRank: update_crew_tier_state::IsSet,
    St::UserDid: update_crew_tier_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> UpdateCrewTier<S> {
        UpdateCrewTier {
            tier_rank: self._fields.0.unwrap(),
            user_did: 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>>,
    ) -> UpdateCrewTier<S> {
        UpdateCrewTier {
            tier_rank: self._fields.0.unwrap(),
            user_did: self._fields.1.unwrap(),
            extra_data: Some(extra_data),
        }
    }
}